Категория:
Технические чертежи
Спецификация — это перечень состав ных частей, входящих в данное специфицируемое изделие.
Спецификацию составляют на отдельных листах на каждую сборочную единицу, комплекс или комплект по форме, установленной ГОСТ.
ГОСТ 2. 108—68 устанавливает форму и порядок заполнения спецификаций конструкторских документов на изделия всех отраслей промышленности.
Спецификации состоят из разделов, которые располагают в графе «Наименование» в определенной последовательности: документация; комплексы; сборочные единицы; детали; стандартные изделия; прочие изделия; материалы; комплекты.
Наименование каждого раздела указывается в виде заголовка и подчеркивается.
В раздел «Документация» вносятся документы, составляющие основной комплект конструкторских документов специфицируемого изделия, кроме его спецификации, а также документы основного комплекта записываемых в спецификацию неспецифицируемых составных частей (деталей), кроме их рабочих чертежей.
Внутри каждого раздела запись указанных изделий производится в алфавитном порядке сочетания начальных букв, индексов организаций-разработчиков и далее в порядке возрастания цифр, входящих в обозначение.
В разделы «Комплексы», «Сборочные единицы» и «Детали» вносятся комплексы, сборочные единицы и детали, непосредственно входящие в специфицируемое изделие. Запись ведется в вышеуказанном порядке.
В разделе «Стандартные изделия» записывают изделия, примененные по. стандартам: государственным; отраслевым; республиканским и стандартам предприятий.
В пределах каждой категории стандартов запись производится по однородным группам, а в группах — в алфавитном порядке наименований изделий.
Раздел «Материалы» заполняется в следующем порядке: металлы черные; металлы магнитоэлектрические и ферромагнитные; металлы цветные, благородные и редкие; кабели, провода и шнуры; пластмассы и прессматериалы; лесоматериалы; резиновые и кожевенные материалы; минеральные, керамические и стеклянные материалы; лаки, краски, нефтепродукты и химикаты; прочие материалы.
Раздел «Комплекты» заполняется в такой последовательности: комплект монтажных частей; комплект сменных
частей; комплект запасных частей; комплект инструмента и принадлежностей; комплект укладок; комплект тары; прочие комплекты.
После каждого раздела спецификации необходимо оставлять несколько свободных строк для возможных дополнительных записей.
В графе «Формат» указывается формат документов, обозначение которых записано в графе «Обозначение».
В разделах «Стандартные изделия», «Прочие изделия» и «Материалы» графу «Формат» не заполняют. В графе «Формат» записывают «БЧ», если на данную деталь не выпущены чертежи.
Обозначение зоны, в которой находится записываемая составная часть (при разбивке поля чертежа на зоны по ГОСТ 2.104—68), указывается в графе «Зона».
В графе «Поз.» указывают порядковые номера составных частей специфицируемого изделия.
Спецификацию сборочных единиц, выполненных на листах формата, допускается совмещать со сборочным чертежом, заполняя в том же порядке и по той же форме, что и спецификацию, выполненную на отдельных листах.
Укажите свойства для спецификаций.
Чтобы задать свойства для спецификаций:
Войдите в окно PropertyManager одним из следующих методов:
Выберите Спецификация в панели инструментов «Таблица» или при наличии открытого документа выберите Вставка, Таблицы, Спецификация.
Нажмите на значок перемещения в верхнем левом углу существующей спецификации.
Укажите свойства, указанные ниже, затем нажмите OK .
Выберите:
Создать новую таблицу для создания новой таблицы чертежей.
Скопировать существующую таблицу для копирования спецификации, сохраненной из связанной сборки или детали.
Выберите спецификацию в списке. Выберите параметр Связанная, чтобы связать данные спецификации чертежа со спецификацией сборки. Можно разорвать связь между спецификациями, но ее невозможно восстановить. Изменения, внесенные в одну из спецификаций, отображаются в другой. Форматирование не связывается.
Выберите Открыть шаблон таблицы из спецификации , чтобы указать стандартный или пользовательский шаблон. Это параметр доступен только во время вставки таблицы.
Столбцы спецификации соответствуют столбцам выбранного Вами шаблона.
Неподвижный угол управляет направлением расширения таблицы при добавлении столбцов или строк.
Установите для параметра Привязанный угол значение:
Верхний левый. Новые столбцы добавляются справа, а новые строки — ниже точки привязки.
Верхний правый. Новые столбцы добавляются слева, а новые строки — ниже точки привязки.
Нижний левый. Новые столбцы добавляются справа, а новые строки — над точки привязки.
Нижний правый. Новые столбцы добавляются слева, а новые строки — ниже точки привязки.
Прикрепить к точке привязки. Прикрепляет указанный угол к точке привязки таблицы.
Параметр Привязанный угол не доступен сразу после создания таблицы. Если таблица создается с точкой привязки, то привязанный угол автоматически выбирается на чертежном листе в квадранте, ближайшем к привязке таблицы.
Выберите:
Только верхний уровень. Перечислены детали и узлы, но не компоненты узлов.
Только детали. Не перечислены узлы. Компоненты узлов перечислены как отдельные элементы.
С отступом. Перечислены узлы. Компоненты узлов смещены ниже соответствующих узлов. Выберите:
Нумерация отсутствует
Подробная нумерация
Плоская нумерация
При создании спецификации для документа, включающего сварные изделия, выберите параметр
Подробный список вырезов сварного изделия
, чтобы отобразить данные о вырезах.
Если изменить параметр Тип спецификации существующей спецификации, размер файла документа увеличится, что может привести к снижению производительности. Рекомендуется сначала удалить исходную спецификацию, а затем вставить новую спецификацию желаемого Типа спецификации.
Можно разъединять узлы сборки в спецификации.
Позволяет масштабировать размер спецификации. Доступно при выборе значка перемещения в верхнем левом углу существующей спецификации в документе детали или сборки.
Предоставляет список количественных данных в Спецификациях для всех выбранных конфигураций. Выберите конфигурации вручную или нажмите Выбрать все конфигурации или Отменить выбор всех конфигураций .
Указывает, как детали с множественными конфигурациями в сборке, отображаются в спецификации.
Отобразить под одним номером. Используется один и тот же номер для различных конфигураций компонента в различных конфигурациях сборки верхнего уровня.
Например, одна конфигурация сборки содержит следующие компоненты:
part1 (деталь1) (конфиг_A)
part1 (деталь1) (конфиг_A)
part1 (деталь1) (конфиг_A)
а другая конфигурация этой же сборки содержит разные конфигурации одного и того же компонента:
part1 (деталь1) (конфиг_B)
part1 (деталь1) (конфиг_B)
part1 (деталь1) (конфиг_B)
Спецификация со значением Только верхний уровень, связанная с обеими конфигурациями сборки, для которых выбран параметр Отобразить под одним номером, отображается как:
|
ПОЗИЦИЯ |
ОБОЗНАЧЕНИЕ ДЕТАЛИ |
конфиг_A / К-ВО |
конфиг_B / К-ВО |
|
1 |
part1 (деталь1) (конфиг_A) |
3 |
— |
|
1 |
part1 (деталь1) (конфиг_B) | — |
3 |
Чтобы просмотреть имя конфигурации в столбце НОМЕР ДЕТАЛИ, перейдите к документу деталей.
На вкладке ConfigurationManager нажимайте правой кнопкой мыши на каждую конфигурацию и выбирайте параметр Свойства. В окне Отображаемое обозначение при использовании в спецификации выберите Имя конфигурации. Также можно нажать правой кнопкой мыши на компонент с столбце структура сборки спецификации и выбрать параметр Параметры компонента. В разделе Обозначение детали выберите Имя конфигурации и затем нажмите на .
Отобразить конфигурации одной детали как отдельные элементы. Если компонент содержит несколько конфигураций, каждая конфигурация указывается в спецификации.
Отобразить все конфигурации одной детали как один элемент. Если компонент содержит несколько конфигураций, компонент указывается только в одной строке спецификации.
Отобразить как конфигурации одной позиции с тем же именем. Если несколько компонентов имеют оно и то же имя конфигурации, они будут перечислены в одной строке спецификации. Чтобы правильно использовать этот параметр, для параметра Отображаемое обозначение при использовании в спецификации детали необходимо указать одно из значений.
То же значение для Имя, настроенное пользователем
Имя конфигурации (если разные компоненты сборки обладают одним и тем же именем конфигурации)
Например, сборка содержит следующие компоненты:
part1 (деталь1) (конфиг_A)
part1 (деталь1) (конфиг_A)
part2 (деталь2) (конфиг_A)
Если выбрать Отобразить как конфигурации одной позиции с тем же именем, спецификация отображается следующим образом.
|
ПОЗИЦИЯ |
ОБОЗНАЧЕНИЕ ДЕТАЛИ |
К-ВО |
|
1 |
part1 (деталь1) |
3 |
|
Начать с |
Введите начальную позицию. |
|
Инкремент |
|
|
По порядку сборки |
|
|
Не изменять номера позиций . |
Выберите, что номера позиций спецификации не обновлялись, при изменении этих номеров в других местах. |
Граница рамки и Граница сетки . Выберите соответствующую толщину границы в списке.
Таблица с более толстыми границами рамки и сетки:
В чертежах с именованными слоями выберите нужный слой. Таблица использует цвет слоя.
Спецификация представляет собой документ, в котором конкретизируется предмет договора и уточняются особенности предусмотренных обязательств — в данном случае характеристики услуг, сроки их оказания и т.
д.
Каковы существенные условия договора оказания услуг
Спецификация является неотъемлемой частью договора, о чем должно быть указано в его тексте. Как правило, спецификация составляется в форме таблицы, однако законодателем не ограничен порядок закрепления воли сторон при оформлении документа.
Спецификация к договору необходима оказания услуг:
Чем точнее будет составлена спецификация, тем меньше вопросов возникнет у сторон в ходе исполнения обязательств по договору.
Однако не всегда спецификация необходима для сторон сделки. Если услуги, выполняемые по договору, четко определены и не возникает никаких разногласий в связи с их осуществлением, можно прописать их в предмете договора и избежать составления дополнительных документов.
Спецификация служит для детализации предмета и некоторых условий договора и составляется для удобства сторон. Поэтому в некоторых ситуациях можно обойтись без составления документа. Чаще всего стороны отказываются от отдельной спецификации в следующих случаях:
При отказе от использования спецификации договор оказания услуг не должен содержать ссылки на документ. В противном случае исполнитель или заказчик при возникновении разногласий сможет потребовать от другой стороны соблюдения требования несуществующего документа. Это может создать серьезные проблемы при претензионном и судебном разрешении споров.
Содержание спецификации по договору оказания услуг не закреплено в нормативно-правовых актах. Но практика деловых отношений выработала ряд требований к документу, которые необходимо соблюдать во избежание проблем с исполнением договора:
Например, можно сослаться на другую спецификацию или на условия договора.Не следует перегружать спецификации информацией и дублировать положения договора оказания услуг, не относящиеся к его предмету. В остальном стороны свободны в условиях ее составления и формате представления нужной информации.
У нас вы можете скачать готовый образец спецификации к договору оказания услуг, актуальный в 2021 году. Образец легко адаптировать под специфику деятельности любого предприятия, индивидуального предпринимателя или физического лица:
Образец спецификации к договору оказания услуг
посмотреть
скачать
Таким образом, спецификация является приложением к договору и должна быть составлена в той же форме, что и договор об оказании услуг.
Как правило, в спецификации конкретизируется объем оказываемых услуг, то есть предмет соглашения. В спецификацию допускается вносить изменения, однако они должны быть заверены сторонами в двустороннем порядке, оформлены в письменном виде и приложены к договору.
***
Больше полезной информации — в рубрике «Договор».
Сетевая рабочая группа С. Браднер
Запрос комментариев: 2119 Гарвардский университет
BCP: 14 марта 1997 г.
Категория: Лучшая текущая практика
Ключевые слова для использования в RFC для обозначения уровней требований
Статус этого меморандума
Этот документ определяет лучшие текущие практики Интернета для
Интернет-сообщество, и просит обсуждение и предложения по
улучшения.Распространение памятки не ограничено.
Абстрактный
Во многих стандартных путевых документах используются несколько слов для обозначения
требования в спецификации. Эти слова часто
заглавные. В этом документе эти слова определяются так, как они должны быть
интерпретируется в документах IETF.
Авторы, которые следуют этим рекомендациям
должны включить эту фразу в начале своего документа:
Ключевые слова «ДОЛЖНЫ», «НЕ ДОЛЖНЫ», «ОБЯЗАТЕЛЬНО», «ДОЛЖНЫ», «ДОЛЖНЫ»
НЕ »,« ДОЛЖЕН »,« НЕ ДОЛЖЕН »,« РЕКОМЕНДУЕТСЯ »,« МОЖЕТ »и
«ДОПОЛНИТЕЛЬНО» в этом документе следует толковать, как описано в
RFC 2119.Обратите внимание, что сила этих слов изменена требованием
уровень документа, в котором они используются.
1. ОБЯЗАТЕЛЬНО Это слово или термины «ТРЕБУЕТСЯ» или «ДОЛЖЕН» означать, что
определение является абсолютным требованием спецификации.
2. НЕ ДОЛЖНЫ. Эта фраза или фраза "НЕ ДОЛЖНЫ" означать, что
определение - это абсолютный запрет на указание.
3. СЛЕДУЕТ это слово или прилагательное "РЕКОМЕНДУЕТСЯ" означать, что там
могут существовать веские причины в определенных обстоятельствах игнорировать
конкретный пункт, но необходимо понимать все последствия и
тщательно взвесить, прежде чем выбрать другой курс.4. НЕ ДОЛЖНЫ эта фраза или фраза "НЕ РЕКОМЕНДУЕТСЯ" означать, что
могут существовать уважительные причины в определенных обстоятельствах, когда
конкретное поведение приемлемо или даже полезно, но полное
следует понимать последствия и тщательно взвешивать случай
перед реализацией любого поведения, описанного этим ярлыком.
Bradner Best Current Practice [Страница 1] RFC 2119 Ключевые слова RFC Март 1997 г. 5.МОЖЕТ Это слово или прилагательное «НЕОБЯЗАТЕЛЬНО» означать, что предмет действительно необязательно. Один поставщик может включить товар, потому что конкретная торговая площадка требует этого или потому, что продавец считает, что он улучшает продукт, в то время как другой поставщик может опустить тот же элемент. Реализация, которая не включает конкретную опцию, ДОЛЖНА быть подготовлен к взаимодействию с другой реализацией, которая включить эту опцию, хотя, возможно, и с ограниченной функциональностью. в в том же духе реализация, которая включает в себя конкретную опцию ДОЛЖЕН быть готов к взаимодействию с другой реализацией, которая не включает эту опцию (за исключением, конечно, функции вариант предусматривает.) 6. Рекомендации по использованию этих императивов. Императивы типа, определенного в этом документе, должны использоваться с осторожностью.и экономно. В частности, они ДОЛЖНЫ использоваться только там, где это необходимо. фактически требуется для взаимодействия или для ограничения поведения, которое возможность причинения вреда (например, ограничение повторных передач) Например, их нельзя использовать для навязывания определенного метода на разработчиках, где метод не требуется для совместимость. 7. Соображения безопасности Эти термины часто используются для обозначения поведения с безопасностью. подразумеваемое.Последствия для безопасности невыполнения ОБЯЗАТЕЛЬНО или ДОЛЖЕН или делать то, что в спецификации НЕ ДОЛЖНО или НЕ ДОЛЖНО НЕ делать может быть очень тонким. Авторы документов должны найти время проработать последствия несоблюдения правил безопасности рекомендации или требования, так как у большинства разработчиков не будет извлекли пользу из опыта и обсуждения, которые привели к Спецификация. 8. Благодарности Определения этих терминов представляют собой совокупность определений, взятых из ряда RFC.
Кроме того, были внесены предложения включены из ряда людей, включая Роберта Ульмана, Томаса Нартен, Нил МакБёрнетт и Роберт Элз. Наилучшая текущая практика Брэднера [Страница 2]
RFC 2119 Ключевые слова RFC Март 1997 г.
9. Адрес автора.
Скотт Брэднер
Гарвардский университет
1350 Mass. Ave.
Кембридж, Массачусетс 02138
телефон - +1617 495 3864
электронная почта - sob @ harvard.edu
Лучшие современные практики Брэднера [Страница 3]
Ссылка на следующий текст включена в предисловие ко всем стандартам ISO и другим документам. Эти пояснения призваны помочь разработчикам стандартов и пользователям понять применение и контекст стандартов ISO.
ISO и другие нормативные документы ISO (TS, PAS, IWA) являются добровольными.
Они не включают договорных, юридических или законодательных требований. Добровольные стандарты не заменяют национальные законы, которые, как предполагается, должны соблюдать пользователи стандартов, и которые имеют преимущественную силу.
Следующие определения применяются для понимания того, как внедрить международный стандарт ISO и другие нормативные документы ISO (TS, PAS, IWA).
В Директивах ISO / IEC, Часть 2, 2021, 3.3.3, требование определяется как «выражение в содержании документа, которое передает объективно проверяемые критерии, которые должны быть выполнены, и от которых не допускается отклонение.
разрешено, если требуется соответствие документу.«
В Директивах ISO / IEC, Часть 2, 2021, 3.3.4, рекомендация определяется как «выражение в содержании документа, которое передает предлагаемый возможный выбор или курс действий, которые считаются особенно подходящими. без обязательного упоминания или исключения других «.
Оценка соответствия — это демонстрация того, что установленные требования , относящиеся к продукту, процессу, услуге, человеку, системе или органу, выполнены.
Демонстрация установленных требований может проводиться производителем или поставщиком (первая сторона), пользователем или покупателем (вторая сторона) или независимым органом (третья сторона).
В соответствии с Директивами ISO / IEC, часть 2, 2021, пункт 33, международными стандартами ISO и другими нормативными документами ISO (TS, PAS, IWA), которые содержат требования написаны в соответствии с «принципом нейтральности», так что соответствие может быть оценено первой, второй или третьей стороной.
Международные стандарты ISO и другие нормативные документы ISO (TS, PAS, IWA), которые не содержат требований (т.е. не содержат словесного выражения «должен»), не предназначены для использования для оценки соответствия
Как поясняется в Информационном центре ISO / IEC, Соглашение о технических барьерах в торговле (ТБТ) является одним из юридических текстов Соглашения ВТО.Он обязывает членов ВТО обеспечивать, чтобы, помимо прочего, добровольные стандарты не создавали ненужных препятствий для торговли.
В целях повышения качества международных стандартов и обеспечения эффективного применения ТБТ Комитет ВТО / ТБТ разработал 6 принципов, которые разъясняют и укрепляют концепцию международных стандартов в рамках ТБТ и способствуют достижению его целей.
Эти принципы касаются:
Подробнее о принципах см.
В Приложении 4 ко второму трехлетнему обзору Соглашения по ТБТ.
Эти принципы в равной степени актуальны и должны соблюдаться при разработке международных стандартов (включая стандарты для процедур оценки соответствия). Совет ИСО отметил, что ИСО хорошо соблюдает принципы ВТО, а также опубликовал и продвигал эти принципы среди всех членов ИСО.
| Название термина: аннотация | |
| URI | http://purl.org/dc/terms/abstract |
| Этикетка | Аннотация |
| Определение | Краткое содержание ресурса. |
| Вид срока | Имущество |
| Подсвойство | |
| Название термина: accessRights | |
| URI | http: // изн.org / dc / terms / accessRights |
| Этикетка | Права доступа |
| Определение | Информация о том, кто имеет доступ к ресурсу, или указание его статуса безопасности. |
| Комментарий | Права доступа могут включать информацию о доступе или ограничениях, основанных на конфиденциальности, безопасности или других политиках. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название срока: accrualMethod | |
| URI | http: // изн.org / dc / terms / accrualMethod |
| Этикетка | Метод начисления |
| Определение | Метод, с помощью которого элементы добавляются в коллекцию.![]() |
| Комментарий | Рекомендуется использовать значение из словаря метода начисления описания коллекции [DCMI-ACCRUALMETHOD]. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Имеет домен | http://purl.org/dc/dcmitype/Collection |
| Название срока: accrualPeriodicity | |
| URI | http://purl.org/dc/terms/accrualPeriodicity |
| Этикетка | Периодичность начисления |
| Определение | Частота, с которой элементы добавляются в коллекцию. |
| Комментарий | Рекомендуемая практика — использовать значение из словаря частот описания коллекции [DCMI-COLLFREQ]. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Имеет домен | http://purl.org/dc/dcmitype/Collection |
| Название срока: accrualPolicy | |
| URI | http: // изн.org / dc / terms / accrualPolicy |
| Этикетка | Политика начисления |
| Определение | Политика, регулирующая добавление элементов в коллекцию. |
| Комментарий | Рекомендуется использовать значение из словаря политики начисления описаний коллекции [DCMI-ACCRUALPOLICY]. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Имеет домен | http://purl.org/dc/dcmitype/Collection |
| Название термина: альтернатива | |
| URI | http://purl.org/dc/terms/alternative |
| Этикетка | Альтернативный заголовок |
| Определение | Альтернативное имя ресурса. |
| Комментарий | Различие между заголовками и альтернативными заголовками зависит от приложения. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: аудитория | |
| URI | http://purl.org/dc/terms/audience |
| Этикетка | Аудитория |
| Определение | Класс агентов, для которых предназначен или полезен ресурс. |
| Комментарий | Рекомендуемая практика — использовать это свойство с нелитальными значениями из словаря типов аудитории. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Название срока: доступно | |
| URI | http://purl.org/dc/terms/available |
| Этикетка | Дата выпуска |
| Определение | Дата, когда ресурс стал или станет доступен. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: библиографическое цитирование | |
| URI | http://purl.org/dc/terms/bibliographicCitation |
| Этикетка | Библиографическое цитирование |
| Определение | Библиографическая ссылка на ресурс. |
| Комментарий | Рекомендуемая практика — включать достаточно библиографических подробностей, чтобы идентифицировать ресурс как можно более однозначно. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: соответствует | |
| URI | http://purl.org/dc/terms/conformsTo |
| Этикетка | соответствует |
| Определение | Установленный стандарт, которому соответствует описанный ресурс. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: участник | |
| URI | http: // изн.org / dc / terms / Contributor |
| Этикетка | Автор |
| Определение | Организация, ответственная за внесение вкладов в ресурс. |
| Комментарий | Правила использования имен людей или организаций в качестве авторов распространяются на авторов. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название срока: покрытие | |
| URI | http://purl.org/dc/terms/coverage |
| Этикетка | Покрытие |
| Определение | Пространственная или временная тема ресурса, пространственная применимость ресурса или юрисдикция, к которой относится ресурс. |
| Комментарий | Пространственная тема и пространственная применимость могут быть названным местом или местом, указанным его географическими координатами. Темпоральной темой может быть именованный период, дата или диапазон дат. Юрисдикция может быть названной административной единицей или географическим местом, к которому относится ресурс. Рекомендуемая практика — использовать контролируемый словарь, такой как Тезаурус географических названий Гетти [TGN]. В соответствующих случаях могут использоваться именованные места или периоды времени вместо числовых идентификаторов, таких как наборы координат или диапазоны дат.Поскольку покрытие определяется очень широко, предпочтительно использовать более конкретные подсвойства Временное покрытие и Пространственное покрытие. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: создано | |
| URI | http://purl.org/dc/terms/created |
| Этикетка | Дата создания |
| Определение | Дата создания ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: создатель | |
| URI | http: // изн.org / dc / terms / creator |
| Этикетка | Создатель |
| Определение | Субъект, ответственный за создание ресурса. |
| Комментарий | Рекомендуемая практика — идентифицировать создателя с помощью URI. Если это невозможно или неосуществимо, может быть предоставлено буквальное значение, идентифицирующее создателя. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Эквивалентное свойство |
|
| Подсвойство |
|
| Название срока: дата | |
| URI | http: // изн.org / dc / terms / date |
| Этикетка | Дата |
| Определение | Точка или период времени, связанный с событием в жизненном цикле ресурса. |
| Комментарий | Дата может использоваться для выражения временной информации на любом уровне детализации. Рекомендуемая практика — выражать дату, дату / время или период времени в соответствии с ISO 8601-1 [ISO 8601-1] или опубликованным профилем стандарта ISO, таким как Примечание W3C о форматах даты и времени [W3CDTF] или спецификацию расширенного формата даты / времени [EDTF].Если полная дата неизвестна, можно использовать месяц и год (ГГГГ-ММ) или год (ГГГГ). Диапазоны дат могут быть указаны с использованием спецификации периода времени ISO 8601, в котором даты начала и окончания разделены символом ‘/’ (косая черта). Дата начала или дата окончания может отсутствовать. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название срока: dateAccepted | |
| URI | http://purl.org/dc/terms/dateAccepted |
| Этикетка | Дата принятия |
| Определение | Дата приема ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство.Примеры ресурсов, к которым может относиться дата зачисления, — это диссертация (принята отделением университета) или статья (принята журналом). |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: dateCopyrighted | |
| URI | http://purl.org/dc/terms/dateCopyrighted |
| Этикетка | Дата Защищена авторским правом |
| Определение | Дата возникновения авторских прав на ресурс. |
| Комментарий | Обычно год.Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, которое является второстепенным свойством. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название срока: дата отправки | |
| URI | http://purl.org/dc/terms/dateSubmitted |
| Этикетка | Дата отправки |
| Определение | Дата размещения ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство.Примеры ресурсов, для которых может быть актуальна «Дата отправки», включают диссертацию (отправленную на факультет университета) или статью (отправленную в журнал). |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: описание | |
| URI | http://purl.org/dc/terms/description |
| Этикетка | Описание |
| Определение | Аккаунт ресурса. |
| Комментарий | Описание может включать, но не ограничивается: реферат, оглавление, графическое представление или текстовое описание ресурса. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название срока: educationLevel | |
| URI | http://purl.org/dc/terms/educationLevel |
| Этикетка | Уровень образования аудитории |
| Определение | Класс агентов, определенный с точки зрения продвижения в образовательном или обучающем контексте, для которого предназначен описываемый ресурс. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: степень | |
| URI | http: // изн.org / dc / terms / протяженность |
| Этикетка | Протяженность |
| Определение | Размер или продолжительность ресурса. |
| Комментарий | Рекомендуемая практика — указывать размер файла в мегабайтах и продолжительность в формате ISO 8601. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: формат | |
| URI | http: // изн.org / dc / terms / format |
| Этикетка | Формат |
| Определение | Формат файла, физический носитель или размеры ресурса. |
| Комментарий | Рекомендуемая практика — использовать контролируемый словарный запас, если таковой имеется. Например, для форматов файлов можно использовать список типов Интернет-носителей [MIME]. Примеры размеров включают размер и продолжительность. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: hasFormat | |
| URI | http://purl.org/dc/terms/hasFormat |
| Этикетка | имеет формат |
| Определение | Связанный ресурс, который по существу совпадает с ранее существовавшим описанным ресурсом, но в другом формате. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Is Format Of. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: hasPart | |
| URI | http: // изн.org / dc / terms / hasPart |
| Этикетка | имеет часть |
| Определение | Связанный ресурс, который физически или логически включен в описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Is Part Of. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: hasVersion | |
| URI | http://purl.org/dc/terms/hasVersion |
| Этикетка | Имеет версию |
| Определение | Связанный ресурс, представляющий собой версию, издание или адаптацию описанного ресурса. |
| Комментарий | Изменения в версии подразумевают существенные изменения содержания, а не различия в формате. Это свойство предназначено для использования с нелитральными значениями. Это свойство является обратным свойству Is Version Of. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: идентификатор | |
| URI | http://purl.org/dc/terms/identifier |
| Этикетка | Идентификатор |
| Определение | Однозначная ссылка на ресурс в заданном контексте. |
| Комментарий | Рекомендуемая практика — идентифицировать ресурс с помощью строки, соответствующей системе идентификации.Примеры включают международный стандартный номер книги (ISBN), идентификатор цифрового объекта (DOI) и универсальное имя ресурса (URN). Постоянные идентификаторы должны быть предоставлены как HTTP URI. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: инструктивный метод | |
| URI | http://purl.org/dc/terms/instructionalMethod |
| Этикетка | Метод обучения |
| Определение | Процесс, используемый для формирования знаний, отношений и навыков, для поддержки которых предназначен описанный ресурс. |
| Комментарий | Учебный методобычно включает способы представления учебных материалов или проведения учебных мероприятий, модели взаимодействия ученика с учеником и ученика с преподавателем, а также механизмы, с помощью которых измеряются групповые и индивидуальные уровни обучения. Учебные методы включают в себя все аспекты процесса обучения и обучения, от планирования и реализации до оценки и обратной связи. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Название термина: isFormatOf | |
| URI | http://purl.org/dc/terms/isFormatOf |
| Этикетка | — это формат |
| Определение | Ранее существовавший связанный ресурс, который по существу совпадает с описанным ресурсом, но в другом формате. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Has Format. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: isPartOf | |
| URI | http: // изн.org / dc / terms / isPartOf |
| Этикетка | является частью |
| Определение | Связанный ресурс, в который физически или логически включен описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Has Part. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: isReferencedBy | |
| URI | http://purl.org/dc/terms/isReferencedBy |
| Этикетка | ссылается на |
| Определение | Связанный ресурс, который ссылается, цитирует или иным образом указывает на описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойством Ссылки. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: isReplacedBy | |
| URI | http: // изн.org / dc / terms / isReplacedBy |
| Этикетка | заменяется на |
| Определение | Связанный ресурс, который заменяет, замещает или заменяет описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Replaces. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: isRequiredBy | |
| URI | http://purl.org/dc/terms/isRequiredBy |
| Этикетка | требуется |
| Определение | Связанный ресурс, которому требуется описанный ресурс для поддержки его функции, доставки или согласованности. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Requires. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название срока: выдан | |
| URI | http: // изн.org / dc / terms / выдано |
| Этикетка | Дата выпуска |
| Определение | Дата официального выпуска ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство. |
| Вид срока | Имущество |
| Имеет диапазон | http: // www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: isVersionOf | |
| URI | http: // изн.org / dc / terms / isVersionOf |
| Этикетка | — это версия |
| Определение | Связанный ресурс, для которого описанный ресурс является версией, выпуском или адаптацией. |
| Комментарий | Изменения в версии подразумевают существенные изменения содержания, а не различия в формате. Это свойство предназначено для использования с нелитральными значениями. Это свойство является обратным свойству Has Version. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: язык | |
| URI | http://purl.org/dc/terms/language |
| Этикетка | Язык |
| Определение | Язык ресурса. |
| Комментарий | Рекомендуемая практика заключается в использовании либо нелитального значения, представляющего язык из контролируемого словаря, такого как ISO 639-2 или ISO 639-3, либо буквального значения, состоящего из языкового тега IETF Best Current Practice 47 [IETF-BCP47]. . |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название срока: лицензия | |
| URI | http://purl.org/dc/terms/license |
| Этикетка | Лицензия |
| Определение | Юридический документ, дающий официальное разрешение на какие-либо действия с ресурсом. |
| Комментарий | Рекомендуемая практика — идентифицировать лицензионный документ с помощью URI.Если это невозможно или неосуществимо, может быть предоставлено буквальное значение, идентифицирующее лицензию. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название срока: посредник | |
| URI | http://purl.org/dc/terms/mediator |
| Этикетка | Посредник |
| Определение | Сущность, которая обеспечивает доступ к ресурсу. |
| Комментарий | В образовательном контексте посредником может быть родитель, учитель, помощник учителя или опекун. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: средний | |
| URI | http: // изн.org / dc / terms / medium |
| Этикетка | Средний |
| Определение | Материальный или физический носитель ресурса. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Домен включает |
|
| Подсвойство |
|
| Название срока: изменено | |
| URI | http: // изн.org / dc / terms / модифицированный |
| Этикетка | Дата изменения |
| Определение | Дата изменения ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство. |
| Вид срока | Имущество |
| Имеет диапазон | http: // www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: происхождение | |
| URI | http: // изн.org / dc / terms / originance |
| Этикетка | Происхождение |
| Определение | Заявление обо всех изменениях в праве собственности и хранении ресурса с момента его создания, которые важны для его подлинности, целостности и интерпретации. |
| Комментарий | Заявление может включать описание любых изменений, которые последовательные хранители вносили в ресурс. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Название термина: издатель | |
| URI | http://purl.org/dc/terms/publisher |
| Этикетка | Издатель |
| Определение | Субъект, ответственный за предоставление ресурса. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: ссылки | |
| URI | http://purl.org/dc/terms/references |
| Этикетка | Список литературы |
| Определение | Связанный ресурс, на который ссылается, цитируется или иным образом указывается описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Is Referenced By. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: отношение | |
| URI | http: // изн.org / dc / terms / Relations |
| Этикетка | Отношение |
| Определение | Связанный ресурс. |
| Комментарий | Рекомендуемая практика — идентифицировать связанный ресурс с помощью URI. Если это невозможно или неосуществимо, может быть предоставлена строка, соответствующая формальной системе идентификации. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: заменяет | |
| URI | http://purl.org/dc/terms/replaces |
| Этикетка | Заменяет |
| Определение | Связанный ресурс, который вытесняется, замещается или заменяется описанным ресурсом. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Is Replaced By. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название срока: требуется | |
| URI | http: // изн.org / dc / terms / требуется |
| Этикетка | Требуется |
| Определение | Связанный ресурс, который требуется описанному ресурсу для поддержки его функции, доставки или согласованности. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Это свойство является обратным свойству Is Required By. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название срока: права | |
| URI | http://purl.org/dc/terms/rights |
| Этикетка | Права |
| Определение | Информация о правах на ресурс. |
| Комментарий | Обычно информация о правах включает в себя заявление о различных правах собственности, связанных с ресурсом, включая права интеллектуальной собственности. Рекомендуемая практика — ссылаться на заявление о правах с помощью URI. Если это невозможно или неосуществимо, может быть предоставлено буквальное значение (имя, метка или краткий текст). |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: rightsHolder | |
| URI | http://purl.org/dc/terms/rightsHolder |
| Этикетка | Правообладатель |
| Определение | Человек или организация, владеющие или управляющие правами на ресурс. |
| Комментарий | Рекомендуемая практика — обращаться к правообладателю с помощью URI. Если это невозможно или неосуществимо, может быть предоставлено буквальное значение, идентифицирующее правообладателя. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Название термина: источник | |
| URI | http: // изн.org / dc / terms / source |
| Этикетка | Источник |
| Определение | Связанный ресурс, из которого получен описанный ресурс. |
| Комментарий | Это свойство предназначено для использования с нелитеральными значениями. Описанный ресурс может быть получен из соответствующего ресурса полностью или частично. Лучшая практика — идентифицировать связанный ресурс с помощью URI или строки, соответствующей формальной системе идентификации. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: пространственный | |
| URI | http: // изн.org / dc / terms / пространственный |
| Этикетка | Пространственное покрытие |
| Определение | Пространственная характеристика ресурса. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: тема | |
| URI | http://purl.org/dc/terms/subject |
| Этикетка | Субъект |
| Определение | Тема ресурса. |
| Комментарий | Рекомендуемая практика — ссылаться на объект с помощью URI. Если это невозможно или неосуществимо, может быть предоставлено буквальное значение, идентифицирующее тему. Оба слова предпочтительно должны относиться к предмету из контролируемого словаря. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название термина: tableOfContents | |
| URI | http://purl.org/dc/terms/tableOfContents |
| Этикетка | Содержание |
| Определение | Список подразделов ресурса. |
| Вид срока | Имущество |
| Подсвойство | |
| Название термина: временный | |
| URI | http: // изн.org / dc / terms / temporal |
| Этикетка | Временное покрытие |
| Определение | Временные характеристики ресурса. |
| Вид срока | Имущество |
| Диапазон включает |
|
| Подсвойство |
|
| Название термина: название | |
| URI | http://purl.org/dc/terms/title |
| Этикетка | Название |
| Определение | Имя, присвоенное ресурсу. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: тип | |
| URI | http: // изн.org / dc / terms / type |
| Этикетка | Тип |
| Определение | Характер или жанр ресурса. |
| Комментарий | Рекомендуемая практика — использовать контролируемый словарь, такой как словарь типов DCMI [DCMI-TYPE]. Чтобы описать формат файла, физический носитель или размеры ресурса, используйте свойство Format. |
| Вид срока | Имущество |
| Подсвойство |
|
| Название срока: действительный | |
| URI | http://purl.org/dc/terms/valid |
| Этикетка | Срок действия |
| Определение | Дата (часто диапазон) срока действия ресурса. |
| Комментарий | Рекомендуемая практика — описывать дату, дату / время или период времени, как рекомендовано для свойства Date, для которого это вспомогательное свойство. |
| Вид срока | Имущество |
| Имеет диапазон | http://www.w3.org/2000/01/rdf-schema#Literal |
| Подсвойство |
|
| Название термина: участник | |
| URI | http: // изн.org / dc / elements / 1.1 / вкладчик |
| Этикетка | Автор |
| Определение | Организация, ответственная за внесение вкладов в ресурс. |
| Комментарий | Правила использования имен людей или организаций в качестве авторов также распространяются на авторов. Как правило, для обозначения сущности следует использовать имя участника. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название срока: покрытие | |
| URI | http://purl.org/dc/elements/1.1/coverage |
| Этикетка | Покрытие |
| Определение | Пространственная или временная тема ресурса, пространственная применимость ресурса или юрисдикция, к которой относится ресурс. |
| Комментарий | Пространственная тема и пространственная применимость могут быть названным местом или местом, указанным его географическими координатами. Темпоральной темой может быть именованный период, дата или диапазон дат. Юрисдикция может быть названной административной единицей или географическим местом, к которому относится ресурс. Рекомендуемая практика — использовать контролируемый словарь, такой как Тезаурус географических названий Гетти [TGN]. В соответствующих случаях могут использоваться именованные места или периоды времени вместо числовых идентификаторов, таких как наборы координат или диапазоны дат. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: создатель | |
| URI | http: // изн.org / dc / elements / 1.1 / creator |
| Этикетка | Создатель |
| Определение | Организация, которая несет основную ответственность за создание ресурса. |
| Комментарий | Примеры Создателя: человек, организация или услуга. Как правило, для обозначения сущности следует использовать имя Создателя. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название срока: дата | |
| URI | http://purl.org/dc/elements/1.1/date |
| Этикетка | Дата |
| Определение | Точка или период времени, связанный с событием в жизненном цикле ресурса. |
| Комментарий | Дата может использоваться для выражения временной информации на любом уровне детализации. Рекомендуемая практика — выражать дату, дату / время или период времени в соответствии с ISO 8601-1 [ISO 8601-1] или опубликованным профилем стандарта ISO, таким как Примечание W3C о форматах даты и времени [W3CDTF] или спецификацию расширенного формата даты / времени [EDTF]. Если полная дата неизвестна, можно использовать месяц и год (ГГГГ-ММ) или год (ГГГГ). Диапазоны дат могут быть указаны с использованием спецификации периода времени ISO 8601, в котором даты начала и окончания разделены символом ‘/’ (косая черта).Дата начала или дата окончания может отсутствовать. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: описание | |
| URI | http: // изн.org / dc / elements / 1.1 / description |
| Этикетка | Описание |
| Определение | Аккаунт ресурса. |
| Комментарий | Описание может включать, но не ограничивается: реферат, оглавление, графическое представление или текстовое описание ресурса. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: формат | |
| URI | http://purl.org/dc/elements/1.1/format |
| Этикетка | Формат |
| Определение | Формат файла, физический носитель или размеры ресурса. |
| Комментарий | Рекомендуемая практика — использовать контролируемый словарный запас, если таковой имеется.Например, для форматов файлов можно использовать список типов Интернет-носителей [MIME]. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: идентификатор | |
| URI | http: // изн.org / dc / elements / 1.1 / идентификатор |
| Этикетка | Идентификатор |
| Определение | Однозначная ссылка на ресурс в заданном контексте. |
| Комментарий | Рекомендуемая практика — идентифицировать ресурс с помощью строки, соответствующей системе идентификации. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: язык | |
| URI | http://purl.org/dc/elements/1.1/language |
| Этикетка | Язык |
| Определение | Язык ресурса. |
| Комментарий | Рекомендуемая практика заключается в использовании либо нелитального значения, представляющего язык из контролируемого словаря, такого как ISO 639-2 или ISO 639-3, либо буквального значения, состоящего из языкового тега IETF Best Current Practice 47 [IETF-BCP47]. . |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: издатель | |
| URI | http: // изн.org / dc / elements / 1.1 / publisher |
| Этикетка | Издатель |
| Определение | Субъект, ответственный за предоставление ресурса. |
| Комментарий | Примеры издателя включают человека, организацию или услугу. Как правило, для обозначения сущности следует использовать имя издателя. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: отношение | |
| URI | http://purl.org/dc/elements/1.1/relation |
| Этикетка | Отношение |
| Определение | Связанный ресурс. |
| Комментарий | Рекомендуемая практика — идентифицировать связанный ресурс с помощью URI.Если это невозможно или неосуществимо, может быть предоставлена строка, соответствующая формальной системе идентификации. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название срока: права | |
| URI | http: // изн.org / dc / elements / 1.1 / права |
| Этикетка | Права |
| Определение | Информация о правах на ресурс. |
| Комментарий | Обычно информация о правах включает в себя заявление о различных правах собственности, связанных с ресурсом, включая права интеллектуальной собственности. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: источник | |
| URI | http://purl.org/dc/elements/1.1/source |
| Этикетка | Источник |
| Определение | Связанный ресурс, из которого получен описанный ресурс. |
| Комментарий | Описанный ресурс может быть получен из соответствующего ресурса полностью или частично.Рекомендуемая передовая практика — идентифицировать связанный ресурс с помощью строки, соответствующей формальной системе идентификации. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: тема | |
| URI | http: // изн.org / dc / elements / 1.1 / subject |
| Этикетка | Субъект |
| Определение | Тема ресурса. |
| Комментарий | Обычно тема будет представлена с помощью ключевых слов, ключевых фраз или классификационных кодов. Рекомендуемая передовая практика — использовать контролируемый словарный запас. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: название | |
| URI | http://purl.org/dc/elements/1.1/title |
| Этикетка | Название |
| Определение | Имя, присвоенное ресурсу. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :.См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название термина: тип | |
| URI | http://purl.org/dc/elements/1.1/type |
| Этикетка | Тип |
| Определение | Характер или жанр ресурса. |
| Комментарий | Рекомендуемая практика — использовать контролируемый словарь, такой как словарь типов DCMI [DCMI-TYPE].Чтобы описать формат файла, физический носитель или размеры ресурса, используйте элемент Format. |
| Вид срока | Имущество |
| Примечание | Второе свойство с тем же именем, что и это свойство, было объявлено в пространстве имен dcterms :. См. Объяснение во введении к документу «Термины метаданных DCMI». |
| Название срока: Агент | |
| URI | http: // изн.org / dc / terms / Агент |
| Этикетка | Агент |
| Определение | Ресурс, который действует или имеет право действовать. |
| Вид срока | Класс |
| Экземпляр | http://purl.org/dc/terms/AgentClass |
| Название термина: AgentClass | |
| URI | http: // изн.org / dc / terms / AgentClass |
| Этикетка | Класс агента |
| Определение | Группа агентов. |
| Вид срока | Класс |
| Подкласс | http://www.w3.org/2000/01/rdf-schema#Class |
| Название термина: BibliographicResource | |
| URI | http: // изн.org / dc / terms / BibliographicResource |
| Этикетка | Библиографический ресурс |
| Определение | Книга, статья или другой документальный ресурс. |
| Вид срока | Класс |
| Название термина: FileFormat | |
| URI | http: // изн.org / dc / terms / FileFormat |
| Этикетка | Формат файла |
| Определение | Формат цифровых ресурсов. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/MediaType |
| Название термина: частота | |
| URI | http: // изн.org / dc / terms / Частота |
| Этикетка | Частота |
| Определение | Частота, с которой что-то повторяется. |
| Вид срока | Класс |
| Название термина: Юрисдикция | |
| URI | http://purl.org/dc/terms/Jurisission |
| Этикетка | Юрисдикция |
| Определение | Степень или диапазон судебных, правоохранительных или иных полномочий. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/LocationPeriodOrJurispting |
| Название срока: LicenseDocument | |
| URI | http://purl.org/dc/terms/LicenseDocument |
| Этикетка | Лицензионный документ |
| Определение | Юридический документ, дающий официальное разрешение на какие-либо действия с ресурсом. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/RightsStatement |
| Название термина: LinguisticSystem | |
| URI | http://purl.org/dc/terms/LinguisticSystem |
| Этикетка | Лингвистическая система |
| Определение | Система знаков, символов, звуков, жестов или правил, используемая в общении. |
| Комментарий | Письменный, разговорный, жестовый и компьютерный языки являются лингвистическими системами. |
| Вид срока | Класс |
| Название термина: Местоположение | |
| URI | http://purl.org/dc/terms/Location |
| Этикетка | Место нахождения |
| Определение | Пространственный регион или названное место. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/LocationPeriodOrJurispting |
| Название термина: LocationPeriodOrJurispting | |
| URI | http://purl.org/dc/terms/LocationPeriodOrJurispting |
| Этикетка | Местоположение, период или юрисдикция |
| Определение | Место, период времени или юрисдикция. |
| Вид срока | Класс |
| Название термина: MediaType | |
| URI | http://purl.org/dc/terms/MediaType |
| Этикетка | Тип носителя |
| Определение | Формат файла или физический носитель. |
| Вид срока | Класс |
| Подкласс | http: // изн.org / dc / terms / MediaTypeOrExtent |
| Название термина: MediaTypeOrExtent | |
| URI | http://purl.org/dc/terms/MediaTypeOrExtent |
| Этикетка | Тип носителя или экстент |
| Определение | Тип или экстент носителя. |
| Вид срока | Класс |
| Название термина: MethodOfAccrual | |
| URI | http: // изн.org / dc / terms / MethodOfAccrual |
| Этикетка | Метод начисления |
| Определение | Метод, с помощью которого ресурсы добавляются в коллекцию. |
| Вид срока | Класс |
| Название термина: MethodOfInstruction | |
| URI | http: // изн.org / dc / terms / MethodOfInstruction |
| Этикетка | Метод инструкций |
| Определение | Процесс, который используется для формирования знаний, отношения и навыков. |
| Вид срока | Класс |
| Название термина: PeriodOfTime | |
| URI | http: // изн.org / dc / terms / PeriodOfTime |
| Этикетка | Период времени |
| Определение | Интервал времени, названный или определяемый его начальной и конечной датами. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/LocationPeriodOrJurispting |
| Название термина: PhysicalMedium | |
| URI | http: // изн.org / dc / terms / PhysicalMedium |
| Этикетка | Физическая среда |
| Определение | Физический материал или носитель. |
| Комментарий | Примеры включают бумагу, холст или DVD. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/MediaType |
| Название термина: PhysicalResource | |
| URI | http: // изн.org / dc / terms / PhysicalResource |
| Этикетка | Физический ресурс |
| Определение | Материальная вещь. |
| Вид срока | Класс |
| Название срока: Политика | |
| URI | http://purl.org/dc/terms/Policy |
| Этикетка | Политика|
| Определение | План или план действий органа власти, предназначенный для влияния и определения решений, действий и других вопросов. |
| Вид срока | Класс |
| Название термина: ProvenanceStatement | |
| URI | http://purl.org/dc/terms/ProvenanceStatement |
| Этикетка | Заявление о происхождении |
| Определение | Любые изменения в праве собственности и хранении ресурса с момента его создания, которые важны для его подлинности, целостности и интерпретации. |
| Вид срока | Класс |
| Название термина: RightsStatement | |
| URI | http://purl.org/dc/terms/RightsStatement |
| Этикетка | Заявление о правах |
| Определение | Заявление о правах интеллектуальной собственности (ПИС) на ресурс или на него, юридический документ, дающий официальное разрешение на какие-либо действия с ресурсом, или заявление о правах доступа. |
| Вид срока | Класс |
| Название термина: SizeOrDuration | |
| URI | http://purl.org/dc/terms/SizeOrDuration |
| Этикетка | Размер или продолжительность |
| Определение | Измерение или протяженность, или время, необходимое для игры или исполнения. |
| Комментарий | Примеры включают количество страниц, указание длины, ширины и ширины или период в часах, минутах и секундах. |
| Вид срока | Класс |
| Подкласс | http://purl.org/dc/terms/MediaTypeOrExtent |
| Название термина: Стандартный | |
| URI | http: // изн.org / dc / terms / Standard |
| Этикетка | Стандартный |
| Определение | Контрольная точка, с которой можно оценивать или сравнивать другие вещи. |
| Вид срока | Класс |
| Название термина: Коллекция | |
| URI | http: // изн.org / dc / dcmitype / Коллекция |
| Этикетка | Коллекция |
| Определение | Агрегирование ресурсов. |
| Комментарий | Коллекция описывается как группа; его части также могут быть описаны отдельно. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: набор данных | |
| URI | http: // изн.org / dc / dcmitype / Dataset |
| Этикетка | Набор данных |
| Определение | Данные, закодированные в определенной структуре. |
| Комментарий | Примеры включают списки, таблицы и базы данных. Набор данных может быть полезен для прямой машинной обработки. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: Событие | |
| URI | http: // изн.org / dc / dcmitype / Событие |
| Этикетка | Событие |
| Определение | Непостоянное событие, зависящее от времени. |
| Комментарий | Метаданные для события предоставляют описательную информацию, которая является основой для обнаружения цели, местоположения, продолжительности и ответственных агентов, связанных с событием. Примеры включают выставку, интернет-трансляцию, конференцию, семинар, день открытых дверей, представление, битву, суд, свадьбу, чаепитие, пожар. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: Изображение | |
| URI | http://purl.org/dc/dcmitype/Image |
| Этикетка | Изображение |
| Определение | Визуальное представление, кроме текста. |
| Комментарий | Примеры включают изображения и фотографии физических объектов, картины, гравюры, рисунки, другие изображения и графику, анимацию и движущиеся изображения, пленки, диаграммы, карты, нотные записи. Обратите внимание, что изображение может включать как электронные, так и физические изображения. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: InteractiveResource | |
| URI | http: // изн.org / dc / dcmitype / InteractiveResource |
| Этикетка | Интерактивный ресурс |
| Определение | Ресурс, требующий взаимодействия со стороны пользователя для понимания, выполнения или опыта. |
| Комментарий | Примеры включают формы на веб-страницах, апплеты, мультимедийные обучающие объекты, службы чата или среды виртуальной реальности. |
| Вид срока | Класс |
| Член: | http: // изн.org / dc / terms / DCMIType |
| Название термина: MovingImage | |
| URI | http://purl.org/dc/dcmitype/MovingImage |
| Этикетка | Движущееся изображение |
| Определение | Серия визуальных представлений, создающих впечатление движения при последовательном показе. |
| Комментарий | Примеры включают анимацию, фильмы, телевизионные программы, видео, зоотропы или визуальный результат моделирования.Экземпляры типа «Движущееся изображение» также должны быть описаны как экземпляры более широкого типа «Изображение». |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Подкласс | http://purl.org/dc/dcmitype/Image |
| Название термина: PhysicalObject | |
| URI | http: // изн.org / dc / dcmitype / PhysicalObject |
| Этикетка | Физический объект |
| Определение | Неодушевленный трехмерный объект или вещество. |
| Комментарий | Обратите внимание, что цифровые представления или заменители этих объектов должны использовать изображение, текст или один из других типов. |
| Вид срока | Класс |
| Член: | http: // изн.org / dc / terms / DCMIType |
| Название срока: Служба | |
| URI | http://purl.org/dc/dcmitype/Service |
| Этикетка | Сервис |
| Определение | Система, обеспечивающая одну или несколько функций. |
| Комментарий | Примеры включают услуги ксерокопирования, банковские услуги, услуги аутентификации, межбиблиотечные ссуды, Z39.50 или веб-сервер. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: Программное обеспечение | |
| URI | http://purl.org/dc/dcmitype/Software |
| Этикетка | Программное обеспечение |
| Определение | Компьютерная программа в исходном или скомпилированном виде. |
| Комментарий | Примеры включают исходный файл C, исполняемый файл MS-Windows .exe или сценарий Perl. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: звук | |
| URI | http: // изн.org / dc / dcmitype / Sound |
| Этикетка | Звук |
| Определение | Ресурс, в первую очередь предназначенный для того, чтобы быть услышанным. |
| Комментарий | Примеры включают формат файла воспроизведения музыки, аудио компакт-диск и записанную речь или звуки. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
| Название термина: StillImage | |
| URI | http: // изн.org / dc / dcmitype / StillImage |
| Этикетка | Неподвижное изображение |
| Определение | Статическое визуальное представление. |
| Комментарий | Примеры включают картины, рисунки, графические изображения, планы и карты. Рекомендуемая передовая практика — назначать тип Text изображениям текстовых материалов. Экземпляры типа «Неподвижное изображение» также должны описываться как экземпляры более широкого типа «Изображение». |
| Вид срока | Класс |
| Член: | http: // изн.org / dc / terms / DCMIType |
| Подкласс | http://purl.org/dc/dcmitype/Image |
| Название термина: текст | |
| URI | http://purl.org/dc/dcmitype/Text |
| Этикетка | Текст |
| Определение | Ресурс, состоящий в основном из слов для чтения. |
| Комментарий | Примеры включают книги, письма, диссертации, стихи, газеты, статьи, архивы списков рассылки. Обратите внимание, что факсимиле или изображения текстов по-прежнему относятся к жанру Text. |
| Вид срока | Класс |
| Член: | http://purl.org/dc/terms/DCMIType |
В Photoshop 4 добавлено несколько типов информации о слоях.0 и новее. Они существуют в конце структуры записей слоев (см. Последнюю строку в разделе «Просмотр записей слоев»). Они имеют следующую структуру:
В следующих разделах описаны различные типы доступных данных, их ключи и их формат.
Данные для корректирующего слоя такие же, как форматы файлов загрузки для каждого формата. См. Дополнительную информацию в разделе «Дополнительные форматы файлов».
Ключ для слоя эффектов — ‘lrFX’ . Данные имеют следующий формат:
Длина | Описание |
|---|---|
4 | Размер: 34 |
4 | Версия: 2 |
4 | Клавиша для режима наложения |
10 | Цветовое пространство |
1 | Непрозрачность |
1 | Включено |
10 | Собственное цветовое пространство |
Информация об инструменте Type (Photoshop 5.Только 0 и 5.5)
Заменен в Photoshop 6.0 и последующих версиях другой структурой с ключом ‘TySh’ (см. См. Параметр объекта инструмента «Текст» (Photoshop 6.0). См. Параметр объекта инструмента «Текст» ).
Ключ «тыШ» . Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 1) |
48 | 6 * 8 чисел двойной точности для информации о преобразовании |
Информация о шрифте | |
2 | Версия (= 6) |
2 | Количество граней |
Следующие 8 полей повторяются для каждого счетчика, указанного выше | |
2 | Стоимость марки |
4 | Данные типа шрифта |
Переменная | Паскаль строка имени шрифта |
Переменная | Паскаль строка названия семейства шрифтов |
Переменная | Паскаль строка имени стиля шрифта |
2 | Значение скрипта |
4 | Количество векторов проектных осей, которым необходимо следовать |
4 | Значение расчетного вектора |
Информация о стиле | |
2 | Количество стилей |
Следующие 10 полей повторяются для каждого счетчика, указанного выше | |
2 | Стоимость марки |
2 | Номинал знака |
4 | Значение размера |
4 | Значение отслеживания |
4 | Значение кернинга |
4 | Начальное значение |
4 | Значение базового сдвига |
1 | Автоматическое включение / выключение кернинга |
1 | Присутствует только в версии <= 5 |
1 | Повернуть вверх / вниз |
Текстовая информация | |
2 | Типовое значение |
4 | Значение масштабного коэффициента |
4 | Значение счета дробовика |
4 | Горизонтальное размещение |
4 | Вертикальное размещение |
4 | Выбрать начальное значение |
4 | Выбрать конечное значение |
2 | Количество строк, т.е.е. количество последующих элементов. |
Следующие 5 полей повторяются для каждого элемента в счетчике строк. | |
4 | Число символов |
2 | Значение ориентации |
2 | Значение выравнивания |
2 | Фактический символ как двухбайтовый символ |
2 | Значение стиля |
Информация о цвете | |
2 | Значение цветового пространства |
8 | 4 * 2-байтовый компонент цвета |
1 | Включение / выключение защиты от псевдонимов |
Имя слоя Unicode (Photoshop 5.0)
Ключ — luni . Данные следующие:
Layer ID (Photoshop 5.0)
Ключ — lyid .
Длина | Описание |
|---|---|
4 | Подпись: ‘8BIM’ |
4 | Ключ: lyid |
4 | Длина: 4 |
4 | ID. |
Информация о слое с объектными эффектами (Photoshop 6.0)
Ключ — ‘lfx2’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия эффектов объекта: 0 |
4 | Версия дескриптора (= 16 для Photoshop 6.0). |
Переменная | Дескриптор (см. Структуру дескриптора) |
Узоры (Photoshop 6.0 и CS (8.0))
Это список шаблонов. Ключ — «Patt», «Pat2» или «Pat3» . Данные следующие:
Длина | Описание |
|---|---|
Для каждого шаблона повторяется следующее. | |
4 | Длина выкройки |
4 | Версия (= 1) |
4 | Режим изображения файла. Поддерживаемые значения: Bitmap = 0; Оттенки серого = 1; Проиндексировано = 2; RGB = 3; CMYK = 4; Многоканальность = 7; Дуотон = 8; Лаборатория = 9. |
4 | Точка: вертикальная, 2 байта и горизонтальная, 2 байта |
Переменная | Имя: строка Unicode |
Переменная | Уникальный идентификатор этого шаблона: строка Pascal |
Переменная | Таблица индексных цветов (256 * 3 значений RGB): присутствует только в том случае, если режим изображения является индексированным цветом |
Переменная | Данные шаблона как список массивов виртуальной памяти |
Длина | Описание |
|---|---|
4 | Версия (= 3) |
4 | Длина |
16 | Прямоугольник: сверху, слева, снизу, справа |
4 | Количество каналов |
Ниже представлен массив виртуальной памяти , повторяющийся для количества каналов + один для пользовательской маски + один для маски листа. | |
4 | Логическое значение, указывающее, записан ли массив, пропустить следующие данные, если 0. |
4 | Длина, пропустить следующие данные, если 0. |
4 | Глубина пикселя: 1, 8, 16 или 32 |
16 | Прямоугольник: сверху, слева, снизу, справа |
2 | Глубина пикселя: 1, 8, 16 или 32 |
1 | Режим сжатия данных.1 — это застежка-молния. |
Переменная | Фактические данные на основе параметров и сжатия |
Аннотации (Photoshop 6.0)
Ключ— «Anno» . Данные следующие:
Длина | Описание |
|---|---|
2 | Основная версия (= 2) |
2 | Дополнительная версия.(= 1) |
4 | Количество аннотаций для отслеживания |
Следующее повторяется для каждой аннотации | |
4 | Длина аннотации |
4 | Тип аннотации: текстовый ( ‘txtA’ ) или звуковой ( ‘sndA’ ). |
1 | Аннотация открыта |
1 | Флаги. |
2 | Дополнительные блоки. (= 1 для Photoshop 6.0) |
16 | Прямоугольник расположения значка: вверху, слева, внизу и справа. |
16 | Прямоугольник расположения всплывающих окон: вверху, слева, внизу и справа |
10 | 2 байта для пробела, за которыми следует компонент цвета 4 * 2 байта |
Переменная | Паскаль строка имени автора, выровненная по 2 байтам |
Переменная | Строка имени Паскаля, выровненная по 2 байтам |
Переменная | Паскаль-строка мода Дата, выровненная по 2 байтам |
4 | Длина следующих 3 полей, включая это поле |
4 | ‘ txtC ‘ или ‘ sndM ‘.Текст или звук |
4 | Длина следующего поля |
Переменная | Актуальные данные для этой аннотации. Текст представляет собой строку ASCII или Unicode; звуковая аннотация задокументирована в PDF Reference , доступном по адресу http://Partners.adobe.com/asn/developer/acrosdk/docs.html#filefmtspecs |
Переменная | Заполнение для выравнивания по 4 байтам |
Смешивание элементов обрезки (Photoshop 6.0)
Ключ — clbl . Данные следующие:
Длина | Описание |
|---|---|
1 | Смешивание обрезанных элементов: логическое |
3 | Прокладка |
Растушевка элементов интерьера (Photoshop 6.0)
Ключ — ‘infx’ . Данные следующие:
Длина | Описание |
|---|---|
1 | Смешать элементы интерьера: логический |
3 | Прокладка |
Настройка выбивки (Photoshop 6.0)
Ключ — knko . Данные следующие:
Длина | Описание |
|---|---|
1 | Выбивка: логическая |
3 | Прокладка |
Защищенная настройка (Photoshop 6.0)
Ключ — lspf . Данные следующие:
Длина | Описание |
|---|---|
4 | Флаги защиты: биты 0–2 используются для Photoshop 6.0. Прозрачность, композит и позиция соответственно. |
Настройка цвета листа (Photoshop 6.0)
Ключ — ‘lclr’ . Данные следующие:
Длина | Описание |
|---|---|
4 * 2 | Цвет.Для Photoshop 6.0 используется только первая настройка цвета; остальные нули |
Контрольная точка (Photoshop 6.0)
Ключ — ‘fxrp’ . Данные следующие:
Длина | Описание |
|---|---|
2 * 8 | 2 двойных значения для опорной точки |
Настройки градиента (Photoshop 6.0)
Ключ — ‘grdm’ . Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 1 для Photoshop 6.0) |
1 | Обратный градиент |
1 | С градиентным смешиванием |
Переменная | Название градиента: Строка Unicode, дополненная |
2 | Количество последовательных цветовых остановок |
Следующее повторяется для каждой остановки цвета | |
4 | Расположение ограничителя цвета |
4 | Средняя точка остановки цвета |
2 | Режим следования цвета |
4 * 2 | Актуальный цвет упора |
2 | Количество контрольных точек прозрачности |
Следующее повторяется для каждой ограничителя прозрачности | |
4 | Расположение ограничителя прозрачности |
4 | Средняя точка упора прозрачности |
2 | Непрозрачность ограничителя прозрачности |
2 | Количество расширений (= 2 для Photoshop 6.0) |
2 | Интерполяция, если указанная выше длина не равна нулю |
2 | Длина (= 32 для Photoshop 6.0) |
2 | Режим для этого градиента |
4 | Случайное число начальных чисел |
2 | Флаг показа прозрачности |
2 | Флаг для использования векторного цвета |
4 | Коэффициент шероховатости |
2 | Цветовая модель |
4 * 2 | Минимальные значения цвета |
4 * 2 | Максимальные значения цвета |
2 | Dummy: не используется в Photoshop 6.0 |
Настройка разделителя разделов (Photoshop 6.0)
Ключ — lsct . Данные следующие:
Длина | Описание |
|---|---|
4 | Тип.4 возможных значения, 0 = любой другой тип слоя, 1 = открытая «папка», 2 = закрытая «папка», 3 = ограничивающий разделитель раздела, скрытый в пользовательском интерфейсе |
Следующее присутствует, только если длина> = 12 | |
4 | Подпись: ‘8BIM’ |
4 | Ключ. См. Ключи режима наложения в разделе «Записи слоев». |
Следующее присутствует, только если длина> = 16 | |
4 | Подтип. 0 = нормально, 1 = группа сцен, влияет на временную шкалу анимации. |
Настройка ограничений на смешение каналов (Photoshop 6.0)
Ключ— ‘brst’ . Данные следующие:
Длина | Описание |
|---|---|
Далее повторяется длина / 4 раза. | |
4 | Ограниченный номер канала |
Настройка однотонного листа (Photoshop 6.0)
Ключ— это «SoCo» . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16 для Photoshop 6.0) |
Переменная | Дескриптор. На основе структуры формата файла действия (см. Структуру дескриптора) |
Настройка заливки узором (Photoshop 6.0)
Ключ — «PtFl» . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16 для Photoshop 6.0) |
Переменная | Дескриптор. На основе структуры формата файла действия (см. Структуру дескриптора) |
Настройка градиентной заливки (Photoshop 6.0)
Ключ — ‘GdFl’ . Данные следующие:
Длина | Описание |
|---|---|
4 байта | Версия (= 16 для Photoshop 6.0) |
Переменная | Дескриптор. На основе структуры формата файла действия (см. Структуру дескриптора) |
Настройка векторной маски (Photoshop 6.0)
Ключ: vmsk или vsms . Если ключ — ‘vsms’ , тогда мы пишем для (Photoshop CS6) , и документ будет иметь ключ ‘vscg’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 3 для Photoshop 6.0) |
4 | Флаги.бит 1 = инвертировать, бит 2 = нет связи, бит 3 = отключить |
Остальные данные — это компоненты пути, цикл до конца длины. | |
Переменная | Пути. См. Раздел Формат ресурса пути |
Настройка объекта инструмента «Текст» (Photoshop 6.0)
Заменяет информацию о типе инструмента в Photoshop 5.0 (см. Раздел «Информация об инструменте« Текст »»).
Ключ — «ТыШ» . Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 1 для Photoshop 6.0) |
6 * 8 | Преобразование: xx, xy, yx, yy, tx и ty соответственно. |
2 | Текстовая версия (= 50 для Photoshop 6.0) |
4 | Версия дескриптора (= 16 для Photoshop 6.0) |
Переменная | Текстовые данные (см. Структуру дескриптора) |
2 | Версия деформации (= 1 для Photoshop 6.0) |
4 | Версия дескриптора (= 16 для Photoshop 6.0) |
Переменная | Данные деформации (см. Структуру дескриптора) |
4 * 8 | слева, сверху, справа, снизу соответственно. |
Внешний эффект ID (Photoshop 6.0)
Ключ — ‘ffxi’ . Данные следующие:
Длина | Описание |
|---|---|
4 | ИД Иностранного эффекта. |
Настройка источника имени слоя (Photoshop 6.0)
Ключ — ‘lnsr’ . Данные следующие:
Длина | Описание |
|---|---|
4 | ID для имени слоя |
Данные выкройки (Photoshop 6.0)
Ключ «шпа» . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 0 для Photoshop 6.0) |
4 | Количество комплектов для отслеживания |
Для подсчета, указанного выше, повторяется следующее. | |
4 | Образец подписи |
4 | Шаблонный ключ |
4 | Количество паттернов в наборе |
1 | Копирование на листе дублирование |
3 | Прокладка |
Следующее повторяется для подсчета вышеперечисленных шаблонов. | |
4 | Обработка цвета. Предпочтительно convert = ‘conv’ , избегать преобразования = ‘avod’ , только яркость = ‘lumi’ |
Переменная | Строка Паскаля, имя шаблона |
Переменная | Строка Unicode, имя шаблона |
Переменная | Паскаль строка уникального идентификатора шаблона |
Параметр метаданных (Photoshop 6.0)
Ключ — ‘shmd’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Количество элементов метаданных, которым необходимо следовать |
Следующее повторяется столько раз, сколько указано выше: | |
4 | Подпись данных |
4 | Ключ данных |
1 | Копирование на листе дублирование |
3 | Прокладка |
4 | Длина данных для отслеживания |
Переменная | Недокументированные данные |
, версия (Photoshop 7.0)
Ключ — «lyvr» . Данные следующие:
Длина | Описание |
|---|---|
4 | 32-битное число, представляющее версию Photoshop, необходимую для чтения и интерпретации слоя без потери данных.70 = 7,0, 80 = 8,0 и т. Д. Минимальное значение — 70, потому что наличие поля в 6.0 вызывает предупреждение. В будущем Photoshop 7 проверяет, больше ли это число, чем текущая версия, то есть 70, и, если да, предупреждает, что игнорирует некоторые данные. |
Прозрачность формирует слой (Photoshop 7.0)
Ключ — «цлы» .Данные следующие:
Длина | Описание |
|---|---|
1 | 1: прозрачность слоя используется для определения формы эффектов. Это значение по умолчанию для поведения, аналогичного предыдущим версиям. 0: обрабатывается так же, как непрозрачность заливки, включая модулирующие режимы наложения, а не действует как строгая прозрачность. Использование этой функции полезно для достижения эффектов, которые в противном случае потребовали бы сложного использования групп отсечения. |
3 | Прокладка |
Маска слоя как глобальная маска (Photoshop 7.0)
Ключ lmgm . Данные следующие:
Длина | Описание |
|---|---|
1 | 1: маска слоя используется в окончательном кроссфейде, маскируя слой и эффекты, а не используется для формирования слоя и его эффектов. Это поведение ранее было привязано к флагу статуса ссылки для маски слоя. (Несвязанная маска действовала как значение флага 1, связанная маска — как 0). Для старых файлов, в которых отсутствует этот ключ, статус ссылки используется для сохранения результатов композитинга. |
3 | Прокладка |
Векторная маска как глобальная маска (Photoshop 7.0)
Ключ — ‘vmgm’ . Данные следующие:
Яркость и контраст
Ключ— ‘brit’ . Данные следующие:
Длина | Описание |
|---|---|
2 | Яркость |
2 | Контрастность |
2 | Среднее значение яркости и контрастности |
1 | Только цвет лаборатории |
Канальный микшер
Ключ— ‘mixr’ .Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 1) |
2 | Монохромный |
20 | Цвет RGB или CMYK плюс константа для настроек микшера.4 * 2 байта цвета с 2 байтами константы. |
Поиск цвета (Photoshop CS6)
Ключ — clrL . Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 1) |
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор черно-белой информации |
Помещенный слой (заменен на SoLd в Photoshop CS3)
Ключ — «plLd» .Данные следующие:
Длина | Описание |
|---|---|
4 | Тип (= ‘plcL’) |
4 | Версия (= 3) |
Переменная | Уникальный идентификатор в виде паскаль-строки |
4 | Номер страницы |
4 | Всего страниц |
4 | Политика псевдонимов Anit |
4 | Тип размещенного слоя: 0 = неизвестно, 1 = вектор, 2 = растр, 3 = стек изображений |
4 * 8 | Преобразование: 8 удвоений для координат x, y точек преобразования |
4 | Деформация (= 0) |
4 | Версия дескриптора деформации (= 16) |
Переменная | Дескриптор информации о деформации |
Связанный слой
Ключ — lnkD .Также ключи ‘lnk2’ и ‘lnk3’ . Данные следующие:
Длина | Описание |
|---|---|
Следующее повторяется для каждого связанного файла. | |
8 | Длина данных для отслеживания |
4 | Тип (= данные связанного файла liFD, внешний связанный файл liFE или псевдоним связанного файла liFA) |
4 | Версия (= от 1 до 7) |
Переменная | Строка Паскаля.Уникальный идентификатор. |
Переменная | Unicode строка исходного имени файла |
4 | Тип файла |
4 | Создатель файлов |
8 | Длина данных для отслеживания |
1 | Дескриптор открытия файла |
Переменная | Дескриптор открытых параметров.Присутствует только когда верно вышеизложенное. |
Если тип — liFE, то следующим будет дескриптор связанного файла. | |
Переменная | Дескриптор параметров связанного файла. См. Комментарий выше. |
Если тип liFE и версия больше 3, то присутствует следующее. Далее идут год, месяц, день, час, минута, секунда. | |
4 | Год |
1 | Месяц |
1 | День |
1 | Час |
1 | Минуты |
8 | Дабл для секунд |
Если тип — liFE, то следующий размер файла. | |
8 | Размер файла |
Если тип liFA, то следующие 4 нуля. | |
8 | Все нули |
Если тип liFE, то следующие байты файла. | |
Переменная | Необработанные байты файла. |
Если версия больше или равна 5, то следующая следующая. | |
UnicodeString | Идентификатор дочернего документа. |
Если версия больше или равна 6, то следующая следующая. | |
Двойной | Время модификации актива. |
Если версия больше или равна 7, то следующая следующая. | |
1 | Состояние блокировки активов для активов библиотек. |
Если тип liFE и версия 2, то следующее. | |
Переменная | Необработанные байты файла. |
Фотофильтр
Ключ — ‘phfl’ . Данные следующие:
Длина | Описание |
|---|---|
2 | Версия (= 3) или (= 2) |
12 | 4 байта каждый для цвета XYZ (только в версии 3) |
10 | Цветовое пространство 2 байта, за которым следует компонент цвета 4 * 2 байта (только в версии 2) |
4 | Плотность |
1 | Сохранить яркость |
Черный Белый (Photoshop CS3)
Ключ — ‘blwh’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор черно-белой информации |
Content Generator Extra Data (Photoshop CS5)
Ключ — ‘CgEd’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор дополнительных данных |
Данные текстового движка (Photoshop CS3)
Ключ— ‘Txt2’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Длина данных для отслеживания |
Переменная | Необработанные байты для текстового движка |
Vibrance (Photoshop CS3)
Ключ — ‘VIBA’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор информации о вибрации |
Имя пути в Юникоде (Photoshop CS6)
Ключ— pths .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор, содержащий список имен путей в Юникоде |
Анимационные эффекты (Photoshop CS6)
Ключ— «anFX» .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор, содержащий эффекты анимации |
Фильтр-маска (Photoshop CS3)
Ключ — «FMsk» .Данные следующие:
Длина | Описание |
|---|---|
10 | Цветовое пространство |
2 | Непрозрачность |
Размещение данных слоя (Photoshop CS3)
Ключ— «SoLd» .См. Также ключ «PlLd» . Данные следующие:
Длина | Описание |
|---|---|
4 | Идентификатор (= ‘soLD’) |
4 | Версия (= 4) |
4 | Версия дескриптора (= 16) |
Переменная | Дескриптор информации размещенного слоя |
Векторные данные обводки (Photoshop CS6)
Ключ — ‘vstk’ .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Данные содержимого векторных штрихов (Photoshop CS6)
Ключ — ‘vscg’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Ключ для данных |
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Использование выравнивания рендеринга (Photoshop CS6)
Ключ — sn2P . Данные следующие:
Длина | Описание |
|---|---|
4 | Ненулевое значение истинно для использования выровненного рендеринга |
Исходные векторные данные (Photoshop CC)
Ключ — vogk .Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 1 для Photoshop CC) |
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Исходные данные пикселей (Photoshop CC)
Ключ— ‘PxSc’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Используемый композитор (Photoshop 2020)
Ключ — cinf . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Исходные данные пикселей (Photoshop CC 2015)
Ключ — «PxSD» . Данные следующие:
Длина | Описание |
|---|---|
8 | Длина данных для отслеживания |
Переменная | Необработанные данные для 3D-слоев или видеослоев. |
Данные артборда (Photoshop CC 2015)
Ключ: ‘artb’ или ‘artd’ или ‘abdd’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Версия (= 16) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Данные слоя смарт-объекта (Photoshop CC 2015)
Ключ — ‘SoLE’ . Данные следующие:
Длина | Описание |
|---|---|
4 | Тип (= ‘soLD’) |
4 | Версия (= 4 или 5) |
Переменная | Дескриптор.На основе структуры формата файла действия (см. Структуру дескриптора) |
Сохранение объединенной прозрачности
Ключ— «Mtrn», «Mt16» или «Mt32» . Нет данных, связанных с этими ключами.
Маска пользователя
Ключ — «ЛМск» .
Длина | Описание |
|---|---|
10 | Цветовое пространство |
2 | Непрозрачность |
1 | Флаг (= 128) |
Экспозиция
Ключ— ‘expA’ .
Длина | Описание |
|---|---|
2 | Версия (= 1) |
4 | Экспозиция |
4 | Смещение |
4 | Гамма |
Эффекты фильтра
Ключ— FXid или FEid .
Длина | Описание |
|---|---|
4 | Версия (= 1, 2 или 3) |
8 | Длина данных для отслеживания |
Для заданной длины повторяется следующее. | |
Переменная | Строка Паскаля как идентификатор |
4 | Версия (= 1) |
8 | Длина |
16 | Прямоугольник: сверху, слева, снизу, справа |
4 | Глубина |
4 | Макс.каналов |
Следующее повторяется для количества каналов + маска пользователя + маска листа. | |
4 | Логическое значение, указывающее, записан ли массив |
8 | Длина |
2 | Режим сжатия данных. |
Переменная | Фактические данные на основе сжатия |
Конец повтора для каналов | |
1 | Следующие два элемента присутствуют или нет |
2 | Режим сжатия данных для отслеживания |
Переменная | Фактические данные на основе сжатия |
Иногда мы работаем над новой функцией в нашем коде и хотим написать для нее спецификацию, пока еще не реализовали эту функцию.Чтобы указать, что мы знаем, что спецификация не удастся, пока мы реализуем эту функцию, мы можем добавить аннотацию @PendingFeature к нашему методу спецификации. С этой аннотацией Спок по-прежнему будет выполнять тест, но установит статус «Игнорировать», если тест не пройден. Но если тест проходит успешно, устанавливается статус «Неудача». Поэтому, когда мы закончим работу над функцией, нам нужно удалить аннотацию, и Спок любезно напомнит нам сделать это таким образом.
В следующем примере спецификации мы используем аннотацию @PendingFeature :
образец пакета
импортный спок.lang.Specification
import spock.lang.PendingFeature
импорт spock.lang.Subject
class SampleSpec расширяет спецификацию {
@Предмет
частный финальный конвертер = новый конвертер ()
@PendingFeature
void 'новая функция, позволяющая сделать строковый верхний регистр' () {
данный:
def value = 'Спок потрясающий'
ожидать: // Это не удастся, как ожидалось
Converter.upper (value) == 'SPOCK IS УДИВИТЕЛЬНЫЙ'
}
}
class Converter {
Верхняя строка (строковое значение) {
ценность
}
}
Когда мы запускаем наш тест, например, в Gradle, мы получаем следующий результат:
Теперь давайте реализуем метод upper :
образец пакета
импортный спок.lang.Specification
import spock.lang.PendingFeature
импорт spock.lang.Subject
class SampleSpec расширяет спецификацию {
@Предмет
частный финальный конвертер = новый конвертер ()
@PendingFeature
void 'новая функция, позволяющая сделать строковый верхний регистр' () {
данный:
def value = 'Спок потрясающий'
ожидать: // Это больше не будет ошибкой
Converter.upper (value) == 'SPOCK IS УДИВИТЕЛЬНЫЙ'
}
}
class Converter {
Верхняя строка (строковое значение) {
value.toUpperCase ()
}
}
Мы снова запускаем тест, и теперь мы получаем неудачный результат, хотя наша реализация метода upper верна:
Итак, это говорит нам, что @PendingFeature больше не нужен.Мы можем удалить его, и спецификация пройдет правильно.
Написано со Споком 1.1.
Федеральный окружной апелляционный суд подтвердил решение Совета по патентным испытаниям и апелляциям о том, что описание патента не содержит письменного описания, подтверждающего ограничения диапазона в оспариваемых пунктах формулы изобретения. Indivior UK Ltd. против Reddy’s Labs. S.A., No. 2020-2073, 2020-2142, 2021 U.S. App. LEXIS 34959, at * 1 (Федеральный округ, 24 ноября 2021 г.). Если заявлен диапазон, «квалифицированный специалист должен уметь разумно различать раскрытие этого диапазона», id. на 8, и в этом случае суд установил, что отдельные примеры, попадающие в заявленные диапазоны, не обеспечивают достаточной письменной поддержки описания этих диапазонов.
Определение того, поддерживается ли заявленный диапазон спецификацией, зависит от фактов, поэтому это решение не может быть решающим во всех ситуациях.Однако при составлении заявки на патент следует явно указать многочисленные вариации потенциальных диапазонов, включая вариации, охватывающие все примеры, а также вариации, которые включают дискретные подмножества примеров в описании. Как и во всех случаях письменного описания, чем больше примеров, тем лучше. Эти шаги важны как никогда, потому что решение Indivior требует большей поддержки диапазонов, чем предыдущий прецедент Федерального округа.
Ожидание зависело от того, имели ли рассматриваемые претензии поддержку письменного описания в исходной заявке в том виде, в котором она была подана.В патенте обычно описываются растворимые в полости рта пленки, содержащие терапевтические агенты. В формуле изобретения указаны ограничения, определяющие количество водорастворимой полимерной матрицы, включая «от примерно 40 мас.% До примерно 60 мас.%», «От примерно 48,2 мас.% До примерно 58,6 мас.%» И «примерно 48,2 мас.%» Матрицы. Эти диапазоны не были явно заявлены или указаны в исходной заявке, и поэтому вопрос заключался в том, может ли квалифицированный специалист «разумно различить» раскрытие каждого диапазона из описания. ид. по адресу * 8.
Формулировка спецификации была двусмысленной — в ней отмечались различные допустимые процентные содержания и говорилось, что количество полимерного материала может варьироваться. Таблицы в спецификации содержат подробные примеры, которые попадают в заявленные диапазоны, но проценты не раскрываются явно и должны быть рассчитаны на основе данных в таблицах.
Федеральный округ заявил, что использование этих точек данных из примеров в спецификации для поддержки заявленных диапазонов «равносильно объединению чисел постфактум.«Идентификатор на * 10. Чтобы удовлетворить требование письменного описания, спецификация должна« указывать на изобретение », а не приглашать читателя« отправиться в охотничью экспедицию, чтобы склеить после факта синтетическое определение изобретения ». Раскрытие примеров, которые попадали в заявленные диапазоны, обеспечило недостаточную письменную поддержку описаний диапазонов, отсутствие более конкретного раскрытия. Примечательно, что Федеральный округ действительно подтвердил интерпретацию Совета, согласно которой раскрытие поддерживает ограничение притязаний на «около 48».2 мас.% », Даже несмотря на то, что процентное содержание не было явно указано в спецификации, потому что ограничение указывало как конкретное количество, а не диапазон .
Один судья не согласен с мнением, заявив, что «большинство не ссылается на авторитетные источники, подтверждающие, что письменное описание для поддержки« замкнутого диапазона »требует раскрытия замкнутого диапазона, а не отдельных значений». ид. по адресу * 15. Несогласие также отметило, что это мнение противоречит предыдущим решениям Федерального округа, разрешающим использование дискретных значений для обеспечения письменного описания диапазонов.В несогласии утверждается, что письменное описание было удовлетворено, поскольку спецификация «явно определяет основные желаемые характеристики, которыми обладают пленки по заявленному изобретению, и определяет уровни полимера, необходимые для придания этих характеристик». ид. Кроме того, совокупный весовой процент полимеров в каждом варианте осуществления в примерах составлял либо 48,2%, либо 58,6%, цифру, которую легко рассчитать специалист в данной области. Таким образом, несогласие сочло бы письменное описание удовлетворительным для заявленных диапазонов.
Ключевые слова «ДОЛЖЕН», «НЕ ДОЛЖЕН», «ОБЯЗАТЕЛЬНО», «ДОЛЖЕН», «НЕ ДОЛЖЕН», «ДОЛЖЕН», «НЕ ДОЛЖЕН», «РЕКОМЕНДУЕТСЯ», «МОЖЕТ» и «ДОПОЛНИТЕЛЬНО» должны интерпретироваться, как описано в RFC 2119.
Спецификация Swagger находится под лицензией Apache License версии 2.0.
Swagger ™ — это проект, используемый для описания и документирования RESTful API.
Спецификация Swagger определяет набор файлов, необходимых для описания такого API. Эти файлы затем могут использоваться проектом Swagger-UI для отображения API и Swagger-Codegen для создания клиентов на разных языках. Дополнительные утилиты также могут использовать полученные файлы, например инструменты тестирования.
| Версия | Дата | Банкноты |
|---|---|---|
| 2,0 | 08.09.2014 | Выпуск Swagger 2.0 |
| 1,2 | 2014-03-14 | Первоначальный выпуск официального документа. |
| 1,1 | 22.08.2012 | Выпуск Swagger 1.1 |
| 1,0 | 10.08.2011 | Первый выпуск спецификации Swagger |
Шаблон пути означает использование фигурных скобок ({}) для пометки части пути URL как заменяемой с использованием параметров пути.
Определения Mime-типов разбросаны по нескольким ресурсам. Определения MIME-типов должны соответствовать RFC 6838.
Некоторые примеры возможных определений MIME-типов:
текст / обычный; charset = utf-8
приложение / json
приложение / vnd.github + json
приложение / vnd.github.v3 + json
приложение / vnd.github.v3.raw + json
приложение / vnd.github.v3.text + json
приложение / vnd.github.v3.html + json
приложение / vnd.github.v3.full + json
приложение / vnd.github.v3.diff
application / vnd.github.v3.patch
Коды состояния HTTP используются для обозначения состояния выполненной операции. Доступные коды состояния описаны в RFC 7231 и в Реестре кодов состояния IANA.
Файлы, описывающие RESTful API в соответствии со спецификацией Swagger, представлены как объекты JSON и соответствуют стандартам JSON. YAML, являясь надмножеством JSON, также может использоваться для представляют файл спецификации Swagger.
Например, если считается, что поле имеет значение массива, будет использоваться представление массива JSON:
Хотя API описывается с использованием JSON, он не требует ввода / вывода JSON для самого API.
Все имена полей в спецификации чувствительны к регистру .
Схема предоставляет два типа полей. Фиксированные поля с объявленным именем и шаблонные поля, которые объявляют шаблон регулярного выражения для имени поля. Шаблонные поля могут иметь несколько экземпляров, если каждое имеет уникальное имя.
Swagger-представление API состоит из одного файла. Однако части определений могут быть разделены на отдельные файлы по усмотрению пользователя. Это применимо для полей $ ref в спецификации, как следует из определений схемы JSON.
По соглашению файл спецификации Swagger называется swagger.json .
Примитивные типы данных в спецификации Swagger основаны на типах, поддерживаемых в проекте 4 схемы JSON.Модели описываются с помощью объекта схемы, который является подмножеством проекта 4 схемы JSON.
Дополнительный примитивный тип данных «файл» используется объектом параметра и объектом ответа для установки типа параметра или ответа как файла.
Примитивы имеют необязательное свойство модификатора формата . Swagger использует несколько известных форматов для более точного определения используемого типа данных. Однако свойство формата - это открытая строка формата со значением и может иметь любое значение для поддержки документации.Такие форматы, как «email» , «uuid» и т. Д., Могут использоваться, даже если они не определены в данной спецификации. Типы, которые не сопровождаются свойством , следуют своему определению из схемы JSON (за исключением типа файла , который определен выше). Форматы, определенные в спецификации Swagger:
| Общее название | тип | формат | Комментарии |
|---|---|---|---|
| целое | целое | внутр32 | 32 бита со знаком |
| длинный | целое | внутр 64 | 64 бита со знаком |
| поплавок | номер | поплавок | |
| двойной | номер | двойной | |
| строка | строка | ||
| байт | строка | байт | символов в кодировке base64 |
| двоичный | строка | двоичный | любая последовательность октетов |
| логический | логический | ||
| дата | строка | дата | Согласно определению , полная дата - RFC3339 |
| дата и время | строка | дата-время | Согласно определению дата-время - RFC3339 |
| пароль | строка | пароль | Используется для подсказки пользовательскому интерфейсу, который необходимо скрыть. |
Это объект корневого документа для спецификации API. Он объединяет то, что раньше было списком ресурсов и декларацией API (версия 1.2 и ранее), в один документ.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| чванство | строка | Обязательно. Задает используемую версию спецификации Swagger. Он может использоваться пользовательским интерфейсом Swagger и другими клиентами для интерпретации списка API. Значение ДОЛЖНО быть "2,0" . | ||
| информация | Информационный объект | Обязательно. Предоставляет метаданные об API. При необходимости клиенты могут использовать метаданные. | ||
| хост | строка | Хост (имя или IP), обслуживающий API. Он ДОЛЖЕН быть только хостом и не включает ни схему, ни подпути.Он МОЖЕТ включать порт. Если хост не включен, должен использоваться хост, обслуживающий документацию (включая порт). Хост не поддерживает создание шаблонов пути. | ||
| basePath | строка | Базовый путь, по которому обслуживается API, относительно хоста . Если он не включен, API обслуживается непосредственно хостом . Значение ДОЛЖНО начинаться с ведущей косой черты (/). basePath не поддерживает создание шаблонов пути. | ||
| схемы | [ строка ] | Протокол передачи API. Значения ДОЛЖНЫ быть из списка: «http» , «https» , «ws» , «wss» . Если схемы не включены, по умолчанию будет использоваться схема, используемая для доступа к самому определению Swagger. | ||
| потребляет | [ строка ] | Список типов MIME, которые могут использовать API.Это глобально для всех API, но может быть отменено для определенных вызовов API. Значение ДОЛЖНО быть таким, как описано в разделе "Типы Mime". | ||
| производит | [ строка ] | Список типов MIME, которые могут создавать API. Это глобально для всех API, но может быть отменено для определенных вызовов API. Значение ДОЛЖНО быть таким, как описано в разделе "Типы Mime". | ||
| дорожек | Путь объекта | Обязательно. Доступные пути и операции для API. | ||
| определения | Объект определений | Объект для хранения типов данных, созданных и потребляемых операциями. | ||
| параметры | Объект определения параметров | Объект для хранения параметров, которые могут использоваться во всех операциях. Это свойство не определяет глобальные параметры для всех операций. | ||
| ответов | Ответы Определения Объект | Объект для хранения ответов, которые можно использовать во всех операциях.Это свойство не определяет глобальные ответы для всех операций. | ||
| безопасность Определения | Объект определений безопасности | Определения схемы безопасности, которые могут использоваться в спецификации. | ||
| безопасность | [Объект требований безопасности] | Объявление того, какие схемы безопасности применяются для API в целом. Список значений описывает альтернативные схемы безопасности, которые можно использовать (то есть между требованиями безопасности существует логическое ИЛИ).Отдельные операции могут отменять это определение. | ||
| теги | [Тег объекта] | Список тегов, используемых в спецификации, с дополнительными метаданными. Порядок тегов можно использовать для отражения их порядка с помощью инструментов синтаксического анализа. Не все теги, которые используются объектом операции, должны быть объявлены. Необъявленные теги могут быть организованы случайным образом или на основе логики инструментов. Каждое имя тега в списке ДОЛЖНО быть уникальным. | ||
| внешние документы | Объект внешней документации | Дополнительная внешняя документация.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Объект предоставляет метаданные об API. При необходимости метаданные могут использоваться клиентами и для удобства могут быть представлены в пользовательском интерфейсе Swagger.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| титул | строка | Обязательно. Название приложения. | ||
| описание | строка | Краткое описание приложения. Синтаксис GFM можно использовать для форматированного текстового представления. | ||
| Условия обслуживания | строка | Условия использования API. | ||
| контакт | Контактный объект | Контактная информация для открытого API. | ||
| лицензия | Объект лицензии | Информация о лицензии для открытого API.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"title": "Образец приложения Swagger",
"description": "Это пример сервера Petstore server.",
"termsOfService": "http://swagger.io/terms/",
"контакт": {
"name": "Поддержка API",
"url": "http: // www.swagger.io/support ",
"электронная почта": "[email protected]"
},
"лицензия": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"версия": "1.0.1"
} title: Образец приложения Swagger описание: Это пример сервера Petstore server. termsOfService: http://swagger.io/terms/ контакт: имя: Поддержка API URL: http://www.swagger.io/support электронная почта: [email protected] лицензия: имя: Apache 2.0 URL: http://www.apache.org/licenses/LICENSE-2.0.html версия: 1.0,1
Контактная информация для открытого API.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| название | строка | Идентификационное имя контактного лица / организации. | ||
| url | строка | URL-адрес, указывающий на контактную информацию. ДОЛЖЕН быть в формате URL.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"name": "Поддержка API",
"url": "http://www.swagger.io/support",
"электронная почта": "[email protected]"
} имя: Поддержка API URL: http: // www.swagger.io/support электронная почта: [email protected]
Информация о лицензии для открытого API.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| название | строка | Обязательно. Имя лицензии, используемой для API. | ||
| url | строка | URL-адрес лицензии, используемой для API.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
} имя: Apache 2.0 URL: http://www.apache.org/licenses/LICENSE-2.0.html
Содержит относительные пути к отдельным конечным точкам. Путь добавляется к basePath для создания полного URL-адреса.
Пути могут быть пустыми из-за ограничений ACL.
| Схема поля | Тип | Описание | ||
|---|---|---|---|---|
| / {path} | Объект Path Item | Относительный путь к отдельной конечной точке. Имя поля ДОЛЖНО начинаться с косой черты.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"/домашние питомцы": {
"получить": {
"description": "Возвращает всех питомцев из системы, к которой у пользователя есть доступ",
"производит": [
"приложение / json"
],
"ответы": {
"200": {
"description": "Список домашних животных.",
"schema": {
"тип": "массив",
"Предметы": {
"$ ref": "# / definitions / pet"
}
}
}
}
}
}
} / домашних животных:
получить:
описание: возвращает всех питомцев из системы, к которой у пользователя есть доступ
производит:
- приложение / json
ответы:
'200':
описание: Список домашних животных.
схема:
тип: массив
Предметы:
$ ref: '# / definitions / pet' Описывает операции, доступные на одном пути.Элемент пути может быть пустым из-за ограничений ACL. Сам путь по-прежнему доступен для просмотра документации, но они не будут знать, какие операции и параметры доступны.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| за исх. | строка | Позволяет внешнее определение этого элемента пути. Упомянутая структура ДОЛЖНА быть в формате объекта Path Item.Если есть конфликты между указанным определением и определением этого элемента пути, поведение будет undefined . | ||
| получить | Операционный объект | Определение операции GET на этом пути. | ||
| положить | Операционный объект | Определение операции PUT на этом пути. | ||
| пост | Операционный объект | Определение операции POST на этом пути. | ||
| удалить | Операционный объект | Определение операции DELETE на этом пути. | ||
| варианты | Операционный объект | Определение операции OPTIONS на этом пути. | ||
| головка | Операционный объект | Определение операции HEAD на этом пути. | ||
| патч | Операционный объект | Определение операции PATCH на этом пути. | ||
| параметры | [Объект параметра | Справочный объект] | Список параметров, применимых для всех операций, описанных в этом пути. Эти параметры можно переопределить на уровне операции, но нельзя там удалить. Список НЕ ДОЛЖЕН включать повторяющиеся параметры. Уникальный параметр определяется комбинацией имени и местоположения. Список может использовать ссылочный объект для связи с параметрами, которые определены в параметрах объекта Swagger.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"получить": {
"description": "Возвращает домашних животных по ID",
"summary": "Найти питомца по идентификатору",
"operationId": "getPetsById",
"производит": [
"приложение / json",
"текст / HTML"
],
"ответы": {
"200": {
"описание": "ответ питомца",
"schema": {
"тип": "массив",
"Предметы": {
"$ ref": "# / definitions / Pet"
}
}
},
"дефолт": {
"описание": "полезная нагрузка ошибки",
"schema": {
"$ ref": "# / definitions / ErrorModel"
}
}
}
},
"параметры": [
{
"имя": "идентификатор",
"в": "путь",
"description": "ID питомца для использования",
"требуется": правда,
"тип": "массив",
"Предметы": {
"тип": "строка"
},
"collectionFormat": "csv"
}
]
} получить:
описание: Возвращает домашних животных на основании ID
резюме: поиск домашних животных по идентификатору
operationId: getPetsById
производит:
- приложение / json
- текст / HTML
ответы:
'200':
описание: ответ питомца
схема:
тип: массив
Предметы:
$ ref: '# / definitions / Pet'
дефолт:
описание: полезная нагрузка ошибки
схема:
$ ref: '# / определений / ErrorModel'
параметры:
- имя: id
в: путь
описание: ID питомца для использования
требуется: true
тип: массив
Предметы:
тип: строка
Формат коллекции: csv Описывает одну операцию API на пути.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| теги | [ строка ] | Список тегов для управления документацией API. Теги могут использоваться для логической группировки операций по ресурсам или любому другому квалификатору. | ||
| сводка | строка | Краткое описание того, что делает операция. Для максимальной читабельности swagger-ui это поле ДОЛЖНО быть меньше 120 символов. | ||
| описание | строка | Подробное объяснение поведения операции. Синтаксис GFM можно использовать для форматированного текстового представления. | ||
| внешние документы | Объект внешней документации | Дополнительная внешняя документация для этой операции. | ||
| OperationId | строка | Уникальная строка, используемая для идентификации операции. Идентификатор ДОЛЖЕН быть уникальным среди всех операций, описанных в API.Инструменты и библиотеки МОГУТ использовать OperationId для однозначной идентификации операции, поэтому рекомендуется следовать общепринятым соглашениям об именах программирования. | ||
| потребляет | [ строка ] | Список типов MIME, которые может использовать операция. Это отменяет определение потребляет в объекте Swagger. Пустое значение МОЖЕТ использоваться для очистки глобального определения. Значение ДОЛЖНО быть таким, как описано в разделе "Типы Mime". | ||
| производит | [ строка ] | Список типов MIME, которые может создать операция.Это переопределяет , производит определение в объекте Swagger. Пустое значение МОЖЕТ использоваться для очистки глобального определения. Значение ДОЛЖНО быть таким, как описано в разделе "Типы Mime". | ||
| параметры | [Объект параметра | Справочный объект] | Список параметров, применимых к этой операции. Если параметр уже определен в элементе пути, новое определение переопределит его, но никогда не сможет удалить. Список НЕ ДОЛЖЕН включать повторяющиеся параметры.Уникальный параметр определяется комбинацией имени и местоположения. Список может использовать ссылочный объект для связи с параметрами, которые определены в параметрах объекта Swagger. Параметр "body" может быть не более одного. | ||
| ответов | Ответы Объект | Обязательно. Список возможных ответов при выполнении этой операции. | ||
| схемы | [ строка ] | Протокол передачи для операции.Значения ДОЛЖНЫ быть из списка: «http» , «https» , «ws» , «wss» . Значение переопределяет определение схемы Swagger Object . | ||
| устарело | логический | Объявляет эту операцию устаревшей. Следует воздержаться от использования заявленной операции. Значение по умолчанию: , ложь . | ||
| безопасность | [Объект требований безопасности] | Объявление того, какие схемы безопасности применяются для данной операции.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"теги": [
"домашний питомец"
],
"summary": "Обновляет питомца в магазине данными формы",
"описание": "",
"operationId": "updatePetWithForm",
"потребляет": [
"application / x-www-form-urlencoded"
],
"производит": [
"приложение / json",
"приложение / xml"
],
"параметры": [
{
"name": "petId",
"в": "путь",
"description": "ID питомца, которого необходимо обновить",
"требуется": правда,
"тип": "строка"
},
{
"name": "name",
"в": "formData",
"description": "Обновлено имя питомца",
"требуется": ложь,
"тип": "строка"
},
{
"имя": "статус",
"в": "formData",
"description": "Обновлен статус питомца",
"требуется": ложь,
"тип": "строка"
}
],
"ответы": {
"200": {
"description": "Питомец обновлен."
},
"405": {
"description": "Неверный ввод"
}
},
"безопасность": [
{
"petstore_auth": [
"написать: домашние животные",
"читать: домашние животные"
]
}
]
} тегов:
- домашний питомец
сводка: обновляет питомца в магазине данными формы
описание: ""
operationId: updatePetWithForm
потребляет:
- приложение / x-www-form-urlencoded
производит:
- приложение / json
- приложение / xml
параметры:
- имя: petId
в: путь
описание: ID питомца, которого нужно обновить
требуется: true
тип: строка
- имя: имя
in: formData
описание: Обновлено имя питомца
требуется: ложь
тип: строка
- имя: статус
in: formData
описание: Обновлен статус питомца
требуется: ложь
тип: строка
ответы:
'200':
описание: Питомец обновлен.'405':
описание: неверный ввод
безопасность:
- petstore_auth:
- напишите: домашние животные
- читать: домашние животные Позволяет ссылаться на внешний ресурс для получения расширенной документации.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| описание | строка | Краткое описание целевой документации. Синтаксис GFM можно использовать для форматированного текстового представления.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"description": "Подробнее здесь",
"url": "https://swagger.io"
} Описание: Подробнее здесь url: https: // чванство.io
Описывает один параметр операции.
Уникальный параметр определяется комбинацией имени и местоположения.
Существует пять возможных типов параметров.
/ items / {itemId} параметр пути - itemId . / items? Id = ### параметр запроса - id . application / x-www-form-urlencoded , multipart / form-data или оба используются в качестве типа содержимого запроса (в определении Swagger потребляет свойств операции). Это единственный тип параметра, который можно использовать для отправки файлов, таким образом поддерживая тип файла .Поскольку параметры формы отправляются в полезной нагрузке, их нельзя объявлять вместе с параметром тела для одной и той же операции. Параметры формы имеют другой формат в зависимости от используемого типа содержимого (для получения дополнительной информации см. Http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4): application / x-www-form-urlencoded - Аналогично формату параметров запроса, но в качестве полезной нагрузки. Например, foo = 1 & bar = swagger - и foo , и bar являются параметрами формы.Обычно это используется для простых передаваемых параметров. multipart / form-data - каждый параметр занимает часть полезной нагрузки с внутренним заголовком. Например, для заголовка Content-Disposition: form-data; name = "submit-name" имя параметра - имя-отправки . Этот тип параметров формы чаще используется для передачи файлов.| Название поля | Тип | Описание |
|---|---|---|
| название | строка | Обязательно. Имя параметра. Имена параметров чувствительны к регистру .
|
| дюйм | строка | Обязательно. Местоположение параметра. Возможные значения: query, header, path, formData или body. |
| описание | строка | Краткое описание параметра. Это может содержать примеры использования. Синтаксис GFM можно использовать для форматированного текстового представления. |
| требуется | логический | Определяет, является ли этот параметр обязательным. Если параметр в «пути» , это свойство требуется и его значение ДОЛЖНО быть истинным .В противном случае свойство МОЖЕТ быть включено, и его значение по умолчанию - false . |
Если в - это "тело" :
| Название поля | Тип | Описание |
|---|---|---|
| схема | Объект схемы | Обязательно. Схема, определяющая тип, используемый для параметра тела. |
Если в - любое значение, кроме "тело" :
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| тип | строка | Обязательно. Тип параметра. Поскольку параметр не находится в теле запроса, он ограничен простыми типами (то есть не объектом). Значение ДОЛЖНО быть одним из "строка" , "число" , "целое число" , "логическое" , "массив" или "файл" . Если тип - это «файл» , потребляет ДОЛЖЕН быть либо «multipart / form-data», , «application / x-www-form-urlencoded» , либо оба, и параметр ДОЛЖЕН быть в "formData" . | ||
| формат | строка | Расширяемый формат для ранее упомянутого типа . Дополнительные сведения см. В разделе «Форматы типов данных». | ||
| allowEmptyValue | логический | Устанавливает возможность передачи параметров с пустыми значениями. Это действительно только для параметров запроса или formData и позволяет отправлять параметр только с именем или с пустым значением. Значение по умолчанию: , ложь . | ||
| шт. | Предметов Объект | Требуется, если тип - «массив». Описывает тип элементов в массиве. | ||
| Формат | строка | Определяет формат массива, если используется тип array. Возможные значения:
csv . | ||
| по умолчанию | * | Объявляет значение параметра, которое сервер будет использовать, если он не указан, например, «счетчик» для управления количеством результатов на странице может по умолчанию равняться 100, если он не указан клиентом в запросе.(Примечание: «default» не имеет значения для обязательных параметров.) См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. В отличие от схемы JSON это значение ДОЛЖНО соответствовать определенному типу для этого параметра. | ||
| максимум | номер | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | ||
| эксклюзивно Максимум | логический | См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | ||
| минимум | номер | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | ||
| эксклюзивно Минимум | логический | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | ||
| макс. Длина | целое | См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. | ||
| мин Длина | целое | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. | ||
| узор | строка | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. | ||
| макс. | целое | См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. | ||
| минЭлементы | целое | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. | ||
| уникальный товар | логический | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. | ||
| перечисление | [*] | См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Параметр тела с определением схемы, на которую имеется ссылка (обычно для определения модели):
{
"имя": "пользователь",
"в": "тело",
"description": "пользователь, которого нужно добавить в систему",
"требуется": правда,
"schema": {
"$ ref": "# / определений / Пользователь"
}
} имя: пользователь в: тело описание: пользователь, которого нужно добавить в систему требуется: true схема: $ ref: '# / definitions / User'
Параметр тела, представляющий собой массив строковых значений:
{
"имя": "пользователь",
"в": "тело",
"description": "пользователь, которого нужно добавить в систему",
"требуется": правда,
"schema": {
"тип": "массив",
"Предметы": {
"тип": "строка"
}
}
} имя: пользователь
в: тело
описание: пользователь, которого нужно добавить в систему
требуется: true
схема:
тип: массив
Предметы:
тип: строка Параметр заголовка с массивом 64-битных целых чисел:
{
"имя": "токен",
"в": "заголовок",
"description": "токен для передачи в качестве заголовка",
"требуется": правда,
"тип": "массив",
"Предметы": {
"тип": "целое число",
"формат": "int64"
},
"collectionFormat": "csv"
} имя: токен в: заголовок описание: токен для передачи в качестве заголовка требуется: true тип: массив Предметы: тип: целое число формат: int64 Формат коллекции: csv
Параметр пути строкового значения:
{
"name": "имя пользователя",
"в": "путь",
"описание": "имя пользователя для получения",
"требуется": правда,
"тип": "строка"
} имя: имя пользователя в: путь описание: имя пользователя для получения требуется: true тип: строка
Необязательный параметр запроса строкового значения, допускающий несколько значений путем повторения параметра запроса:
{
"имя": "идентификатор",
"в": "запрос",
"description": "ID объекта для получения",
"требуется": ложь,
"тип": "массив",
"Предметы": {
"тип": "строка"
},
"collectionFormat": "multi"
} имя: id в: запрос описание: ID объекта для выборки требуется: ложь тип: массив Предметы: тип: строка collectionFormat: multi
Данные формы с типом файла для загрузки файла:
{
"имя": "аватар",
"в": "formData",
"description": "Аватар пользователя",
"требуется": правда,
"тип": "файл"
} имя: аватар in: formData описание: Аватар пользователя требуется: true тип: файл
Ограниченное подмножество объекта items JSON-Schema.х-
x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».Элементы должны быть строкового типа и иметь минимальную длину 2 символа:
{
"тип": "строка",
«minLength»: 2
} тип: строка minДлина: 2
Массив массивов, внутренний массив имеет целочисленный тип, числа должны быть от 0 до 63 (включительно):
{
"тип": "массив",
"Предметы": {
"тип": "целое число",
«минимум»: 0,
«максимум»: 63
}
} тип: массив Предметы: тип: целое число минимум: 0 максимум: 63
Контейнер для ожидаемых ответов операции.Контейнер сопоставляет код ответа HTTP с ожидаемым ответом. От документации не ожидается, что она обязательно будет охватывать все возможные коды ответов HTTP, поскольку они могут быть неизвестны заранее. Однако ожидается, что в документации будут указаны успешный ответ операции и любые известные ошибки.
Значение по умолчанию можно использовать в качестве объекта ответа по умолчанию для всех кодов HTTP, которые отдельно не рассматриваются в спецификации.
Объект ответов ДОЛЖЕН содержать по крайней мере один код ответа, и он ДОЛЖЕН быть ответом на успешный вызов операции.
Ответ 200 об успешной операции и ответ по умолчанию для других (подразумевающий ошибку):
{
"200": {
"description": "домашнее животное будет возвращено",
"schema": {
"$ ref": "# / definitions / Pet"
}
},
"дефолт": {
"description": "Неожиданная ошибка",
"schema": {
"$ ref": "# / definitions / ErrorModel"
}
}
} '200':
описание: домашнее животное будет возвращено
схема:
$ ref: '# / definitions / Pet'
дефолт:
описание: Неожиданная ошибка
схема:
$ ref: '# / definitions / ErrorModel' Описывает отдельный ответ от операции API.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| описание | строка | Обязательно. Краткое описание ответа. Синтаксис GFM можно использовать для форматированного текстового представления. | ||
| схема | Объект схемы | Определение структуры ответа. Это может быть примитив, массив или объект. Если это поле не существует, это означает, что контент не возвращается как часть ответа.В качестве расширения объекта схемы его корневое значение типа также может быть «файлом» . Это ДОЛЖНО сопровождаться соответствующим производит мим-типа. | ||
| заголовки | Заголовки, объект | Список заголовков, отправляемых с ответом. | ||
| примеры | Пример объекта | Пример ответного сообщения. x- | любой | Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Ответ массива сложного типа:
{
"description": "Ответ на сложный массив объектов",
"schema": {
"тип": "массив",
"Предметы": {
"$ ref": "# / definitions / VeryComplexType"
}
}
} описание: ответ на сложный объектный массив
схема:
тип: массив
Предметы:
$ ref: '# / definitions / VeryComplexType' Ответ со строковым типом:
{
"description": "Простой строковый ответ",
"schema": {
"тип": "строка"
}
} описание: простой строковый ответ схема: тип: строка
Ответ с заголовками:
{
"description": "Простой строковый ответ",
"schema": {
"тип": "строка"
},
"заголовки": {
"X-Rate-Limit-Limit": {
"description": "Количество разрешенных запросов в текущем периоде",
"тип": "целое число"
},
"X-Rate-Limit-Remaining": {
"description": "Количество оставшихся запросов в текущем периоде",
"тип": "целое число"
},
"X-Rate-Limit-Reset": {
"description": "Количество секунд до конца текущего периода",
"тип": "целое число"
}
}
} описание: простой строковый ответ
схема:
тип: строка
заголовки:
X-Rate-Limit-Limit:
описание: количество разрешенных запросов в текущем периоде
тип: целое число
Остающийся предел X-скорости:
описание: количество оставшихся запросов в текущем периоде
тип: целое число
X-Скорость-Предел-Сброс:
описание: количество секунд до конца текущего периода
тип: целое число Ответ без возврата значения:
{
"описание": "объект создан"
} описание: объект создан
Перечисляет заголовки, которые могут быть отправлены как часть ответа.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | Объект заголовка | Имя свойства соответствует имени заголовка. Значение описывает тип заголовка. |
Заголовки ограничения скорости:
{
"X-Rate-Limit-Limit": {
"description": "Количество разрешенных запросов в текущем периоде",
"тип": "целое число"
},
"X-Rate-Limit-Remaining": {
"description": "Количество оставшихся запросов в текущем периоде",
"тип": "целое число"
},
"X-Rate-Limit-Reset": {
"description": "Количество секунд до конца текущего периода",
"тип": "целое число"
}
} X-Rate-Limit-Limit: описание: количество разрешенных запросов в текущем периоде тип: целое число Остающийся предел X-скорости: описание: количество оставшихся запросов в текущем периоде тип: целое число X-Скорость-Предел-Сброс: описание: количество секунд до конца текущего периода тип: целое число
Позволяет обмениваться примерами ответов на операции.
| Схема поля | Тип | Описание |
|---|---|---|
| {тип пантомимы} | любой | Имя свойства ДОЛЖНО быть одним из следующих: Операция производит значений (неявных или унаследованных). Значение ДОЛЖНО быть примером того, как будет выглядеть такой ответ. |
Пример ответа для приложения / json mimetype типа данных Pet:
{
"application / json": {
"name": "Пума",
"type": "Собака",
"черный цвет",
"женский пол",
«порода»: «Смешанный»
}
} приложение / json: имя: Пума тип: Собака черный цвет женский пол порода: смешанная
| Схема поля | Тип | Описание |
|---|---|---|
| ^ x- | любой | Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Простой заголовок целочисленного типа:
{
"description": "Количество разрешенных запросов в текущем периоде",
"тип": "целое число"
} описание: количество разрешенных запросов в текущем периоде тип: целое число
Позволяет добавлять метаданные к одному тегу, который используется объектом операции.Наличие объекта тега для каждого тега не является обязательным.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| название | строка | Обязательно. Имя тега. | ||
| описание | строка | Краткое описание тега. Синтаксис GFM можно использовать для форматированного текстового представления. | ||
| внешние документы | Объект внешней документации | Дополнительная внешняя документация для этого тега.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"имя": "домашнее животное",
"description": "Домашние животные"
} имя: домашнее животное описание: Домашние животные
Простой объект, позволяющий ссылаться на другие определения в спецификации.Его можно использовать для ссылки на параметры и ответы, которые определены на верхнем уровне для повторного использования.
Ссылочный объект - это ссылка JSON, в качестве значения которой используется указатель JSON. Для этой спецификации поддерживается только каноническое разыменование.
| Название поля | Тип | Описание |
|---|---|---|
| за исх. | строка | Обязательно. Ссылочная строка. |
{
"$ ref": "# / definitions / Pet"
} $ ref: '# / definitions / Pet'
{
"$ ref": "definitions.json # / Pet"
} $ ref: 'definitions.yaml # / Pet'
Объект схемы позволяет определять типы входных и выходных данных. Эти типы могут быть объектами, а также примитивами и массивами.Этот объект основан на проекте 4 спецификации схемы JSON и использует его предопределенное подмножество. Помимо этого подмножества, в данной спецификации предусмотрены расширения, позволяющие получить более полную документацию.
Дополнительную информацию о свойствах можно найти в JSON Schema Core и JSON Schema Validation. Если не указано иное, определения свойств соответствуют спецификации схемы JSON, указанной здесь.
Следующие свойства взяты непосредственно из определения схемы JSON и соответствуют тем же спецификациям:
Следующие свойства взяты из определения схемы JSON, но их определения были скорректированы в соответствии со спецификацией Swagger.Их определение такое же, как и в схеме JSON, только там, где исходное определение ссылается на определение схемы JSON, вместо этого используется определение объекта схемы.
Кроме полей подмножества схемы JSON, следующие поля могут использоваться для дальнейшей документации схемы.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| дискриминатор | строка | Добавляет поддержку полиморфизма.Дискриминатор - это имя свойства схемы, которое используется для различения других схем, наследующих эту схему. Используемое имя свойства ДОЛЖНО быть определено в этой схеме и ДОЛЖНО быть в обязательном списке свойств . При использовании значение ДОЛЖНО быть именем этой схемы или любой схемы, которая ее наследует. | ||
| Только чтение | логический | Актуально только для определений "свойств" схемы . Объявляет свойство как «только для чтения».Это означает, что он МОЖЕТ быть отправлен как часть ответа, но НЕ ДОЛЖЕН быть отправлен как часть запроса. Свойства, отмеченные как | ||
| xml | Объект XML | МОЖЕТ использоваться только в схемах свойств. Это не влияет на корневые схемы. Добавляет дополнительные метаданные для описания формата XML-представления этого свойства.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Swagger позволяет комбинировать и расширять определения модели с помощью свойства allOf схемы JSON, фактически предлагая композицию модели. allOf принимает массив определений объектов, которые проверяются независимо , но вместе составляют единый объект.
Хотя композиция предлагает расширяемость модели, она не подразумевает иерархию между моделями. Для поддержки полиморфизма Swagger добавляет поддержку поля дискриминатора . При использовании дискриминатора дискриминатор будет именем свойства, используемого для принятия решения о том, какое определение схемы используется для проверки структуры модели.Таким образом, поле ДОЛЖНО быть обязательным полем. Значение выбранного свойства должно быть понятным именем, присвоенным модели в соответствии с определением свойством . Таким образом, определения встроенных схем, которые не имеют заданного идентификатора , не могут использоваться в полиморфизме.
Свойство xml допускает дополнительные определения при переводе определения JSON в XML. Объект XML содержит дополнительную информацию о доступных параметрах.
В отличие от предыдущих версий Swagger, определения схемы также могут использоваться для описания примитивов и массивов.
{
"тип": "строка",
"формат": "электронная почта"
} тип: строка формат: электронная почта
{
"тип": "объект",
"обязательный": [
"название"
],
"характеристики": {
"название": {
"тип": "строка"
},
"адрес": {
"$ ref": "# / определений / Адрес"
},
"возраст": {
"тип": "целое число",
"формат": "int32",
«минимум»: 0
}
}
} тип: объект
обязательный:
- название
характеристики:
название:
тип: строка
адрес:
$ ref: '# / определений / Адрес'
возраст:
тип: целое число
формат: int32
минимум: 0 МодельДля простого преобразования строки в строку:
{
"тип": "объект",
"additionalProperties": {
"тип": "строка"
}
} тип: объект AdditionalProperties: тип: строка
Для сопоставления строки с моделью:
{
"тип": "объект",
"additionalProperties": {
"$ ref": "# / definitions / ComplexModel"
}
} тип: объект AdditionalProperties: $ ref: '# / definitions / ComplexModel'Модель
{
"тип": "объект",
"характеристики": {
"я бы": {
"тип": "целое число",
"формат": "int64"
},
"название": {
"тип": "строка"
}
},
"обязательный": [
"название"
],
"пример": {
"name": "Пума",
"id": 1
}
} тип: объект
характеристики:
я бы:
тип: целое число
формат: int64
название:
тип: строка
обязательный:
- название
пример:
имя: Пума
id: 1 {
"definitions": {
"ErrorModel": {
"тип": "объект",
"обязательный": [
"сообщение",
"код"
],
"характеристики": {
"сообщение": {
"тип": "строка"
},
"code": {
"тип": "целое число",
«минимум»: 100,
«максимум»: 600
}
}
},
"ExtendedErrorModel": {
"все": [
{
"$ ref": "# / definitions / ErrorModel"
},
{
"тип": "объект",
"обязательный": [
"основная причина"
],
"характеристики": {
"основная причина": {
"тип": "строка"
}
}
}
]
}
}
} определений:
ErrorModel:
тип: объект
обязательный:
- сообщение
- код
характеристики:
сообщение:
тип: строка
код:
тип: целое число
минимум: 100
максимум: 600
ExtendedErrorModel:
все:
- $ ref: '# / definitions / ErrorModel'
- тип: объект
обязательный:
- основная причина
характеристики:
основная причина:
тип: строка {
"definitions": {
"Домашний питомец": {
"тип": "объект",
"дискриминатор": "petType",
"характеристики": {
"название": {
"тип": "строка"
},
"petType": {
"тип": "строка"
}
},
"обязательный": [
"название",
"petType"
]
},
"Кот": {
"description": "Изображение кота",
"все": [
{
"$ ref": "# / definitions / Pet"
},
{
"тип": "объект",
"характеристики": {
"untingSkill ": {
"тип": "строка",
"description": "Измеряемый навык для охоты",
"по умолчанию": "ленивый",
"перечисление": [
"невежественный",
"ленивый",
"авантюрный",
"агрессивный"
]
}
},
"обязательный": [
"охотничье мастерство"
]
}
]
},
"Собака": {
"description": "Изображение собаки",
"все": [
{
"$ ref": "# / definitions / Pet"
},
{
"тип": "объект",
"характеристики": {
"packSize": {
"тип": "целое число",
"формат": "int32",
"description": "размер стаи собаки",
"по умолчанию": 0,
«минимум»: 0
}
},
"обязательный": [
"packSize"
]
}
]
}
}
} определений:
Домашний питомец:
тип: объект
дискриминатор: petType
характеристики:
название:
тип: строка
petType:
тип: строка
обязательный:
- название
- petType
Кот:
описание: Изображение кошки
все:
- $ ref: '# / definitions / Pet'
- тип: объект
характеристики:
охотничий навык:
тип: строка
описание: Измеряемый навык для охоты.
по умолчанию: ленивый
перечисление:
- невежественный
- ленивый
- авантюрный
- агрессивный
обязательный:
- охотничье мастерство
Собака:
описание: Изображение собаки
все:
- $ ref: '# / definitions / Pet'
- тип: объект
характеристики:
packSize:
тип: целое число
формат: int32
описание: размер стаи собаки
по умолчанию: 0
минимум: 0
обязательный:
- размер упаковки Объект метаданных, позволяющий более точно настраивать определения модели XML.
При использовании массивов имена элементов XML являются , а не (для форм единственного / множественного числа), и для добавления этой информации следует использовать свойство name . См. Примеры ожидаемого поведения.
| Название поля | Тип | Описание | ||
|---|---|---|---|---|
| название | строка | Заменяет имя элемента / атрибута, используемого для описанного свойства схемы.Если он определен в объекте Items ( элементов ), он повлияет на имя отдельных элементов XML в списке. Когда он определен рядом с типом , является массивом (за пределами элементов ), это повлияет на элемент упаковки, и только если завернутый будет истинным . Если завернутый будет ложным , он будет проигнорирован. | ||
| пространство имен | строка | URL-адрес определения пространства имен.Значение ДОЛЖНО быть в форме URL. | ||
| префикс | строка | Префикс, который будет использоваться для имени. | ||
| атрибут | логический | Объявляет, преобразуется ли определение свойства в атрибут, а не в элемент. Значение по умолчанию: , ложь . | ||
| в упаковке | логический | МОЖЕТ использоваться только для определения массива. x- | любой | Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
Примеры определений объекта XML включены в определение свойства объекта схемы с образцом его представления XML.
Базовое свойство строки:
{
"animals": {
"тип": "строка"
}
} Базовое свойство строкового массива ( завернутый - false по умолчанию):
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка"
}
}
} животных:
тип: массив
Предметы:
тип: строка <животные>... <животные> ... <животные> ...
{
"animals": {
"тип": "строка",
"xml": {
"имя": "животное"
}
}
} животных:
тип: строка
xml:
название: животное В этом примере показано полное определение модели.
{
"Человек": {
"тип": "объект",
"характеристики": {
"я бы": {
"тип": "целое число",
"формат": "int32",
"xml": {
"атрибут": истина
}
},
"название": {
"тип": "строка",
"xml": {
"пространство имен": "http: // чванство.io / schema / sample ",
"префикс": "образец"
}
}
}
}
} Человек:
тип: объект
характеристики:
я бы:
тип: целое число
формат: int32
xml:
атрибут: истина
название:
тип: строка
xml:
пространство имен: http://swagger.io/schema/sample
префикс: образец <Лицо>
пример sample: name>
Изменение названий элементов:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка",
"xml": {
"имя": "животное"
}
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
название: животное значение значение
Внешнее имя свойство не влияет на XML:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка",
"xml": {
"имя": "животное"
}
},
"xml": {
"имя": "пришельцы"
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
имя: животное
xml:
имя: пришельцы значение значение
Даже когда массив обернут, если имя не определено явно, одно и то же имя будет использоваться как внутри, так и снаружи:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка"
},
"xml": {
"завернутый": правда
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
завернутый: true <животные>значение значение
Чтобы преодолеть приведенный выше пример, можно использовать следующее определение:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка",
"xml": {
"имя": "животное"
}
},
"xml": {
"завернутый": правда
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
имя: животное
xml:
завернутый: true <животные>значение значение
Влияет как на внутренние, так и на внешние имена:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка",
"xml": {
"имя": "животное"
}
},
"xml": {
"name": "пришельцы",
"завернутый": правда
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
имя: животное
xml:
имя: пришельцы
завернутый: true <пришельцы>значение значение
Если поменять внешний элемент, а не внутренний:
{
"animals": {
"тип": "массив",
"Предметы": {
"тип": "строка"
},
"xml": {
"name": "пришельцы",
"завернутый": правда
}
}
} животных:
тип: массив
Предметы:
тип: строка
xml:
имя: пришельцы
завернутый: true <пришельцы>ценность ценность
Объект для хранения типов данных, которые могут использоваться и создаваться операциями.Эти типы данных могут быть примитивами, массивами или моделями.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | Объект схемы | Одно определение, сопоставляющее «имя» с определяемой им схемой. |
{
"Категория": {
"тип": "объект",
"характеристики": {
"я бы": {
"тип": "целое число",
"формат": "int64"
},
"название": {
"тип": "строка"
}
}
},
"Тег": {
"тип": "объект",
"характеристики": {
"я бы": {
"тип": "целое число",
"формат": "int64"
},
"название": {
"тип": "строка"
}
}
}
} Категория:
тип: объект
характеристики:
я бы:
тип: целое число
формат: int64
название:
тип: строка
Тег:
тип: объект
характеристики:
я бы:
тип: целое число
формат: int64
название:
тип: строка Объект для хранения параметров, которые будут повторно использоваться во всех операциях.Определения параметров можно ссылаться на те, которые определены здесь.
Это не , а определяет глобальные рабочие параметры.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | Объект параметров | Определение одного параметра, сопоставляющее "имя" определяемому параметру. |
{
"skipParam": {
"name": "пропустить",
"в": "запрос",
"описание": "количество элементов, которые нужно пропустить",
"требуется": правда,
"тип": "целое число",
"формат": "int32"
},
"limitParam": {
"name": "limit",
"в": "запрос",
"description": "максимальное количество возвращаемых записей",
"требуется": правда,
"тип": "целое число",
"формат": "int32"
}
} skipParam: имя: пропустить в: запрос описание: количество элементов, которые нужно пропустить требуется: true тип: целое число формат: int32 limitParam: имя: предел в: запрос описание: максимальное количество возвращаемых записей требуется: true тип: целое число формат: int32
Объект для хранения ответов для повторного использования во всех операциях.Определения ответов можно ссылаться на те, которые определены здесь.
Это не , а не определяет ответы глобальных операций.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | Объект ответа | Определение одиночного ответа, сопоставляющее «имя» с ответом, который он определяет. |
{
"Не обнаружена": {
"description": "Объект не найден."
},
"IllegalInput": {
"description": "Незаконный ввод для работы".
},
"Общая ошибка": {
"description": "Общая ошибка",
"schema": {
"$ ref": "# / definitions / GeneralError"
}
}
} NotFound:
описание: Сущность не найдена.
IllegalInput:
описание: Незаконный ввод в эксплуатацию.
Общая ошибка:
описание: Общая ошибка
схема:
$ ref: '# / definitions / GeneralError' Объявление схем безопасности, доступных для использования в спецификации.Это не навязывает схемы безопасности для операций, а служит только для предоставления соответствующих деталей для каждой схемы.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | Объект схемы безопасности | Определение единой схемы безопасности, сопоставляющее "имя" схеме, которую оно определяет. |
{
"api_key": {
"тип": "apiKey",
"name": "api_key",
"в": "заголовок"
},
"petstore_auth": {
"тип": "oauth3",
"authorizationUrl": "http: // чванство.io / api / oauth / dialog ",
"поток": "неявный",
"scopes": {
"write: pets": "изменить домашних животных в вашем аккаунте",
"читать: домашние животные": "читать своих питомцев"
}
}
} api_key:
тип: apiKey
имя: api_key
в: заголовок
petstore_auth:
тип: oauth3
authorizationUrl: http://swagger.io/api/oauth/dialog
поток: неявный
объемы:
напишите: pets: измените pets в своем аккаунте
читать: домашние животные: читать ваши домашние животные Позволяет определять схему безопасности, которая может использоваться операциями.Поддерживаемые схемы: базовая проверка подлинности, ключ API (в виде заголовка или параметра запроса) и общие потоки OAuth3 (неявные, пароль, приложение и код доступа).
| Название поля | Тип | Срок действия | Описание | ||
|---|---|---|---|---|---|
| тип | строка | любой | Обязательно. Тип схемы безопасности. Допустимые значения: «basic» , «apiKey» или «oauth3» . | ||
| описание | строка | любой | Краткое описание схемы безопасности. | ||
| наименование | строка | apiKey | Обязательно. Имя заголовка или параметра запроса, который будет использоваться. | ||
| дюйм | строка | apiKey | Обязательно Расположение ключа API.Допустимые значения: «запрос» или «заголовок» . | ||
| поток | строка | oauth3 | Обязательно. Поток, используемый схемой безопасности OAuth3. Допустимые значения: «неявный» , «пароль» , «приложение» или «код доступа» . | ||
| authorizationUrl | строка | oauth3 ( "неявный" , "accessCode" ) | Обязательно. URL-адрес авторизации, который будет использоваться для этого потока. Это ДОЛЖНО быть в форме URL. | ||
| tokenUrl | строка | oauth3 ( «пароль» , «приложение» , «код доступа» ) | Обязательно. URL-адрес токена, который будет использоваться для этого потока. Это ДОЛЖНО быть в форме URL. | ||
| прицелов | Прицелы Объект | oauth3 | Обязательно.х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"тип": "apiKey",
"name": "api_key",
"в": "заголовок"
} тип: apiKey имя: api_key в: заголовок
{
"тип": "oauth3",
"authorizationUrl": "http: // чванство.io / api / oauth / dialog ",
"поток": "неявный",
"scopes": {
"write: pets": "изменить домашних животных в вашем аккаунте",
"читать: домашние животные": "читать своих питомцев"
}
} тип: oauth3 authorizationUrl: http://swagger.io/api/oauth/dialog поток: неявный объемы: напишите: pets: измените pets в своем аккаунте читать: домашние животные: читать ваши домашние животные
Перечисляет доступные области для схемы безопасности OAuth3.
| Схема поля | Тип | Описание | ||
|---|---|---|---|---|
| {имя} | строка | Сопоставляет имя области с ее кратким описанием (как значение свойства).х- | любой | Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика». |
{
"write: pets": "изменить домашних животных в вашем аккаунте",
"читать: домашние животные": "читать своих питомцев"
} написать: pets: изменить pets в вашем аккаунте читать: домашние животные: читать ваши домашние животные
Перечисляет необходимые схемы безопасности для выполнения этой операции.В объекте может быть объявлено несколько схем безопасности, которые все являются обязательными (то есть между схемами существует логическое И).
Имя, используемое для каждого свойства, ДОЛЖНО соответствовать схеме безопасности, объявленной в определениях безопасности.
| Схема поля | Тип | Описание |
|---|---|---|
| {имя} | [ строка ] | Каждое имя должно соответствовать схеме безопасности, объявленной в определениях безопасности.Если схема безопасности имеет тип «oauth3» , то значение представляет собой список имен областей, необходимых для выполнения. Для других типов схем безопасности массив ДОЛЖЕН быть пустым. |
{
"petstore_auth": [
"написать: домашние животные",
"читать: домашние животные"
]
} petstore_auth: - напишите: домашние животные - читать: домашние животные
Хотя спецификация Swagger пытается учесть большинство случаев использования, в определенные моменты могут быть добавлены дополнительные данные для расширения спецификации.
Свойства расширений всегда имеют префикс "x-" и могут иметь любое допустимое значение формата JSON.
Расширения могут поддерживаться или не поддерживаться доступными инструментами, но они также могут быть расширены для добавления запрошенной поддержки (если инструменты являются внутренними или имеют открытый исходный код).
Некоторые объекты в спецификации Swagger могут быть объявлены и оставаться пустыми или полностью удалены, даже если они по сути являются ядром документации API.
Причина в том, чтобы разрешить дополнительный уровень контроля доступа к самой документации. Хотя это и не является частью самой спецификации, некоторые библиотеки могут разрешить доступ к частям документации на основе некоторой формы аутентификации / авторизации.
Два примера для этого:
Об авторе