Skip to content

Connector API: document Get sell limit state - #93

Draft
bhsaurabh wants to merge 6 commits into
mainfrom
feature/RMS-8908-sell-limits-connector-docs
Draft

bhsaurabh wants to merge 6 commits into
mainfrom
feature/RMS-8908-sell-limits-connector-docs

Conversation

@bhsaurabh

Copy link
Copy Markdown

Summary

Documentation for the new Connector API operation Get sell limit state (sellLimits/getState), which returns the effective sell limit, spaces sold and spaces available per rate, resource category and day for a daily service. The operation is merged in the monolith (MewsSystems/mews#88597 and #88008) and is being published under [Restricted].

Four hand-written changes:

  • connector-api/SUMMARY.md: entries for the concept page and the generated operation page.
  • connector-api/changelog/README.md: a new entry, marked as a restricted operation.
  • connector-api/use-cases/revenue-management.md: a Sell limits section after Restrictions, in the same shape.
  • connector-api/concepts/sell-limits.md: new page covering the behaviours a generated reference cannot carry: null limit versus a limit of zero, negative availability, which level is reported when several caps apply and that the broader level wins a tie, that pooled values must not be summed across categories, which reservations count as sold, and per-night consumption.

Why this is a draft

connector-api/operations/selllimits.md is generated by the Regenerate Connector API reference workflow from the demo Swagger, and the operation is not in the demo OAS until the publish PR deploys. Until then the links to that page are dead by construction. Sequence to land this:

  1. Publish PR merges and reaches demo.
  2. Trigger the regenerate workflow (workflow_dispatch) or wait for the Thursday run; commit the generated operations/selllimits.md onto this branch.
  3. Confirm the anchor #get-sell-limit-state matches the generated heading.
  4. Set the changelog entry date to the publication date (currently 2026-09-15 as a placeholder).
  5. Mark ready for review.

Notes for reviewers

Terminology follows CONTRIBUTING.md and the tone-of-voice section of AGENTS.md. Sentences are structured to avoid dashes rather than choose between en and em.

🤖 Generated with Claude Code

bhsaurabh and others added 6 commits September 2, 2026 08:17
Adds the hand-written half of the Sell limits documentation: a nav entry,
a changelog entry, a Sell limits section in the Revenue management use
case, and a new Concepts page.

The Concepts page covers the three behaviours a generated reference page
cannot express: which limit is reported when a rate and its rate group are
both capped, which reservation states count as sold, and that a limit is
consumed per night of stay rather than on the departure date. It also
states that a null limit is different from a configured limit of zero and
that available capacity can be negative.

The operations/selllimits.md reference page is generated from the demo
OAS, so this cannot be merged until the operation is published and reaches
demo. Until then the SUMMARY entry points at a page that does not exist.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The negative-availability section credited an override permission that does
not exist; no sell-limit bypass privilege is present in the codebase, and
ManageSellLimits is a profile privilege for configuring limits rather than
exceeding them. Lowering a limit below the sold count is the supportable
cause and is now the only one stated.

The evaluation-order claim that sell limits are applied after availability
and restrictions was not verified against the pricing path, so both pages
now describe the limit as a separate constraint without asserting an order.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Follows the contract restructure in the monolith. The concepts page described one
record per combination with scalar Limit, Sold and Available; the response is now
a time series with the axis factored out once and metric arrays indexed against
it, so the page documents that shape, the alignment guarantee, and how to read a
single day out of it. The use case note and the changelog entry follow.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Follows the contract review. When the binding cap sits at a level broader than
one resource category, every category under it reports the same shared numbers,
and the level can differ per day. Summing Available across categories in that
case double counts, which is the oversell the operation exists to prevent. The
concept page now says so where it explains which level is reported.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Follows the monolith rename to sellLimits/getState. Anchors and link text updated;
the generated reference page keeps its filename, only its heading changes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The changelog conflict was two entries prepended at the top; both kept, newest first.
The sell limits entry is dated 2026-09-15 for now and should be set to the publication
date when this merges.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant