Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Swagger API documentation nicknames should include unique for each operation #11229

@cianclarke

Description

@cianclarke

cc @smarterclayton
As I understand it, the nickname for each operation should be unique[1]. I searched the open issues, and could not find an open issue relating to this, however my apologies if this is a duplicate.
Since the introduction of 'namespaced' apis (/api/v1/services v.s./api/v1/namespaces/{namespaces}/services), there are operations with duplicate nicknames [2][3].
This means when we try to consume APIs via their swagger definition, the client overwrites the namespaced version of the API with the non-namespaced version.
Maybe listService and listServiceByNamespace might be the convention to go by?

Thanks @webron for the help in IRC confirming this

[1] OAI/OpenAPI-Specification#64
[2] https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/swagger-spec/v1.json#L9961
[3] https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/swagger-spec/v1.json#L10863

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions