Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DEVDOCS-4878: [external] API specs, update Operation IDs to be consistent & programmatic #45

Merged
merged 15 commits into from
Jan 15, 2024
Merged

DEVDOCS-4878: [external] API specs, update Operation IDs to be consistent & programmatic #45

merged 15 commits into from
Jan 15, 2024

Commits on Sep 16, 2023

  1. bugfix: enquote value on order product options example. 

    Otherwise OpenAPI parsing error is:

Colons must be followed by a space or an indication character (i.e. " ", ",", "[", "]", "{", "}") at line 2195 (near "value: {\"originalName\":\"BigCommerceLogo.jpeg\",\"temporaryPath\":\"121_fbfb71dfc5a5d911f62d8e35dedd6e45.jpeg\",\"path\":\"f606efcae7e179970b19c3658142c5d0.jpeg\"}").
    @bobbyshaw
    bobbyshaw committed Sep 16, 2023
    Configuration menu
    Copy the full SHA
    abc7842 View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2023

  1. chore: update operation IDs to be consistent and follow programmatic … 

    …conventions.

As per OpenAPI specification guidance for operationID field, follow programmatic
conventions for operationId field. To me that means as if I were defining a method
or function name.

This field is not used in the API docs as far as I can tell. There were
many different naming conventions across APIs. I've aligned to be camel case.

This help facilitate API SDK generation as all endpoints can have a function named
based on the operation ID and it have sufficient context to be unique amongst all APIs
    @bobbyshaw
    bobbyshaw committed Sep 17, 2023
    Configuration menu
    Copy the full SHA
    762f088 View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2023

  1. Merge branch 'main' into chore/consistent-operation-ids

    Sarah Riehl committed Sep 19, 2023
    Configuration menu
    Copy the full SHA
    b534c66 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2023

  1. Merge branch 'main' into chore/consistent-operation-ids

    @bc-stephen-hilliard
    bc-stephen-hilliard committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    64d6db9 View commit details
    Browse the repository at this point in the history

Commits on Jan 15, 2024

  1. merge main into feature, resolve conflicts

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    a211701 View commit details
    Browse the repository at this point in the history

  2. update linting errors

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    e4ca748 View commit details
    Browse the repository at this point in the history

  3. dedupe priceLists

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    4376323 View commit details
    Browse the repository at this point in the history

  4. set initial lowercase on camelCase operationIds

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    5f9a693 View commit details
    Browse the repository at this point in the history

  5. resolve file/spacing errors

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    aa702ec View commit details
    Browse the repository at this point in the history

  6. update spectral exceptions

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    9da7c49 View commit details
    Browse the repository at this point in the history

  7. add operationId to customer_login

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    ce7146e View commit details
    Browse the repository at this point in the history

  8. Merge branch 'main' into bobbyshaw-consistent-operation-ids

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    a313aea View commit details
    Browse the repository at this point in the history

  9. copyedit

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    d0d8423 View commit details
    Browse the repository at this point in the history

  10. add operationIds where missing

    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    6204c8f View commit details
    Browse the repository at this point in the history

  11. Merge branch 'bobbyshaw-consistent-operation-ids' of github.com:bigco… 

    …mmerce/docs into bobbyshaw-consistent-operation-ids
    Sarah Riehl committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    ffdfd99 View commit details
    Browse the repository at this point in the history