Is it possible to exclude some of the endpoints from the OpenApi Specs? There are some internal endp...

# http4k

[Cosmin Victor Celea]

Is it possible to exclude some of the endpoints from the OpenApi Specs? There are some internal endpoints, that I want to hide from the specs endpoint.

[dave]

not especially - we've done this before by creating 2 separate contracts and then just composing them, so you get an internal and public APIs on different root urls

[Cosmin Victor Celea]

Good idea 👍

[Cosmin Victor Celea]

Is there a way to define things like server in the spec?

[dave]

it's not built in at the moment. there's an issue: https://github.com/http4k/http4k/issues/433

[dave]

you could do it through an extension, but that would involve messing with the element model directly

[Cosmin Victor Celea]

Sorry to bother you so much today but is there a way to add a description to responseLens object example

[Cosmin Victor Celea]

I see open api keeps complaining that description: null for example responses

[dave]

in the browser?

[Cosmin Victor Celea]

Yep, i am trying to add the docs to swaggerhub

[Cosmin Victor Celea]

[dave]

Body.auto<ArbObject1>("some description").toLens()

[dave]

?

[dave]

if you're around at 4pm BST (london) and want to pop into the office hours session then can maybe answer more questions if you have them?

[Cosmin Victor Celea]

Still null.

[Cosmin Victor Celea]

Sure I will do that if I have any more questions

[Cosmin Victor Celea]

Thank you

[dave]

what's your Jackson setup?

[dave]

are you using straight Jackson or a custom one?

[Cosmin Victor Celea]

straight Jackson

[dave]

you using the swagger editor?

[dave]

or the openapi gui?

[Cosmin Victor Celea]

swagger editor

[dave]

are you actually editing it? or just browsing?

[dave]

if browsing, you can use https://www.http4k.org/openapi3/

[dave]

(if you've got a URL to load it from)

[Cosmin Victor Celea]

I was editing, but is ok I will add the stuff like server manually for now anyway. The docs aren’t going to change that often.

[dave]

the other option is to modify your Jackson to not serialise nulls

[Cosmin Victor Celea]

👍

[dave]

(you only need to modify the one that gets passed into the OpenApi3 renderer)

[Cosmin Victor Celea]

Understood, thank you. Will look into it.

[dave]

np 😄

[Cosmin Victor Celea]

val objectNode =  mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).convertValue(input, JsonNode::class.java)

if(objectNode is ObjectNode)
{
    if(objectNode.has("info"))
    {
        val e: List<ServerOpenApi> = getOpenApiServers()
        val array = mapper.valueToTree<ArrayNode>(e)
        objectNode.putArray("servers").addAll(array)
    }

}

[Cosmin Victor Celea]

created my own version of ConfigurableJackson

[Cosmin Victor Celea]

to exclude nulls and add servers field.

[Cosmin Victor Celea]

Now the definition is valid.

[Cosmin Victor Celea]

Thanks for the tips

[dave]

👍