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.

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

CON-2198 uncomment availibility block in config #651

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

horczech
Copy link
Contributor

Summary

https://mews.atlassian.net/browse/CON-2198: Migrate Availability Blocks page

Follow style guide

Style guide

Check during review

  • The changelog and potentially a deprecation entries are in place.
    • The changelog timestamp is date of merge to develop.
  • JSON example extended.
    • New properties are added to the correct place in the JSON.
  • New properties in the table are added to the correct place.
  • Correct formatting:
    • Spacing is consistent between titles, sections, tables, ...
    • Correct JSON format - indentation.
  • DateTime properties should always be defined in ISO format.

@horczech horczech added the Generator Pull requests related to reference documentation generator label Sep 16, 2024
@horczech horczech self-assigned this Sep 16, 2024
@horczech horczech requested review from a team as code owners September 16, 2024 12:53

#### Release strategy
#### CurrencyValueOldUpdateValue
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know about this problem, I mentioned on backend PR here


| Property | Type | Contract | Description |
| :-- | :-- | :-- | :-- |
| `Value` | [The strategy for automatic release of the availability block.](availabilityblocks.md#the-strategy-for-automatic-release-of-the-availability-block) | required | |
Copy link
Contributor Author

@horczech horczech Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know about the missing description and wrong title. I mentioned it on backend PR here

Copy link
Contributor

@VBuben VBuben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put up some comments, overall in a very good shape 🚀

* `Released` - The block deducts availability, but only for reservations assigned to the block before release. Remaining availability is returned back to general availability \(waitlist\).
* `Canceled` - The block does not deduct availability and cannot have reservations assigned \(waitlist\).
| `EnterpriseIds` | array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| `Extent` | [Availability block extent](availabilityblocks.md#availability-block-extent) | required | Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this one is not required and has default when it's not gonna return anything 😅 Verify it but I would make it reflect actual reality so to avoid confusion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, all extents are optional by default.

operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
operations/availabilityblocks.md Outdated Show resolved Hide resolved
@@ -1,9 +1,9 @@
<!-- AUTOMATICALLY GENERATED, DO NOT MODIFY -->
# Availability blocks

## Get all availability blocks

> This feature is being actively developed, features and behavior of this operation may change at short notice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this statement still apply? If it does, I think we should be using the normal Restricted! label (see other examples in the docs) for consistency. If not, then it should be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Generator Pull requests related to reference documentation generator
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants