Skip to content

Add enum of capabilities for Regions #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

nmelehan
Copy link
Contributor

@nmelehan nmelehan commented Mar 3, 2020

This PR should display the possible values that could be included in the capabilities array of a Region.

However:

  • The current developers site does not display these values with the updates in this PR.
  • If the enum is moved out of the items scope and into the capabilities scope (like below), then the enum does display:
        capabilities:
          type: array
          items:
            type: string
          description: >
              A list of capabilities of this region.
          enum:
          - Linodes
          - NodeBalancers
          - Block Storage
          - Object Storage
          - Kubernetes
          example:
          - Linodes
          - NodeBalancers
          - Block Storage
          - Object Storage
          readOnly: true
          x-linode-cli-display: 3
    
    capabilities-enum-displayed
  • I believe that the above code is incorrect; the openapi docs from Swagger say: All values in an enum must adhere to the specified type. In this code, the type is array, while the elements of the enum are strings.
  • It seems like we should not try to update the spec file with technically incorrect content that happens to render like we want it to. Instead, we should update the renderer so that it works with the correct spec syntax.

I'm going to close this PR, so we don't keep it open while waiting on updating the renderer, while still keeping this as a record of the work done so far

@nmelehan nmelehan closed this Mar 4, 2020
LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022
* Changelog for Cloud manager 0.48.0 and Api 4.0.15 (linode#184)

* Embed ReDocas iframe (linode#187)

* Add test path for testing iframe access on developers.dev (linode#188)

* Reactive path to /api/v4 (linode#189)

* Point Create Account button at login.linode.com (linode#191)

* Point Create Account button at login.linode.com

* Go directly to signup path

* Release 1.0.30: Use iframe to host ReDoc docs (linode#192)

* Release 1.0.30 (linode#190)

* Changelog for Cloud manager 0.48.0 and Api 4.0.15 (linode#184)

* Embed ReDocas iframe (linode#187)

* Add test path for testing iframe access on developers.dev (linode#188)

* Reactive path to /api/v4 (linode#189)

* Update api.html

* Update api.html

* Update api.html

* Testing iframe + base + allow X-Frame (linode#198)

* Fix iframe links (linode#199)

* Testing iframe + base + allow X-Frame

* Try _blank

* Reset env to develop for testing; remove <base> (linode#200)

* Remove base element (linode#201)

* DLC-115 fix mobile menu on iFramed api/v4 page (linode#205)

* Add changelog for API 4.0.16 (linode#203)

* Still have to set this manually until dynamic version is merged (linode#207)

* Changelogs for Cloud Manager 0.49.0 and API 4.0.17 (linode#204)

* Changelogs for Cloud Manager 0.49.0 and API 4.0.17

* Copy fixes

* Copy fixes (linode#206)

* fix few issues with changelogs formatting

* Post-merge fixes

* Update changelog dates (linode#210)

* Update changelog dates (linode#211)

* Update changelog dates

* Display dates updated

* Update development (linode#214)



* Release-1.0.31 (linode#208)

* Changelogs for Cloud Manager 0.49.0 and API 4.0.17 (linode#204)

* Changelogs for Cloud Manager 0.49.0 and API 4.0.17

* Copy fixes

* Copy fixes (linode#206)

* fix few issues with changelogs formatting

* Post-merge fixes

* Update release dates

* Changlog date updates

* DLC-115 fix mobile menu on iFramed api/v4 page (linode#205)

* Manager changelog 0.50.0 (linode#215)

* Add manager 0.50.0 changelog entry

* Copy edit

* Added API Changelog for version 4.0.18

* remove highlighting
LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022
[New] Add Linode JavaScript SDK to Libraries Listing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant