nexmo_api_specification 0.11.5 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59797b79fc2bdf352abb7962f716b3db01d06111
-  data.tar.gz: 77b69d6178834b5ae12910073fa81542f088b352
+  metadata.gz: 942b0f851b744ed741359388a725c5f3164766ce
+  data.tar.gz: 25189c10ea95b5b3948242d3075f0bdabf139e62
 SHA512:
-  metadata.gz: 8a463096efb183165f0b44d8192a2ace7f7abb6c12669bd961bec3f49458a477eed21a1b8393fa3a0595264809be732408b752dfbbf7280528ac90ee4304953f
-  data.tar.gz: 2a318919dd2eb3f355cff0381d2459a4f6079399f3d70297b60d51f98e3ebdee3b0af4c147b9b6998999d83a684fe61856a2e9eb0a5dbffc9cf00be06e35fe97
+  metadata.gz: 5e56d23c25a51ba30e3dc6be5f7d18adb97047367d69c5bfb9c5ffd506b27b1af265fb9e69d86ec02401318596dca31d5e094d8335157651e4113cc8b9a15462
+  data.tar.gz: 1d84a0f5f68e6ba0b16fdb51b8d9b1bc79b4a9ce1a9440757279792e7c949cebd1a7ac39b5491c57d9cfc5fb9d8c0605dbd570f00786fa329e8345bc4515975f

data/README.md

@@ -72,3 +72,42 @@ NexmoApiSpecification::Definition.load(:sms)
 ## Contributing
 
 Contributions are welcome, please follow [GitHub Flow](https://guides.github.com/introduction/flow/index.html)
+
+
+## Publishing
+
+Clone the repo and navigate to its directory:
+
+```
+$ cd api-specification
+```
+
+Bump the latest version in `api-specification/lib/nexmo_api_specification/version.rb`:
+
+```
+//old
+module OasParser
+  VERSION = '1.0.0'.freeze
+end
+
+//new
+module OasParser
+  VERSION = '1.1.0'.freeze
+end
+```
+
+Build the gem:
+
+```
+$ gem build nexmo_api_specification.gemspec
+```
+
+_This will create a `nexmo_api_specification-1.1.0.gem` file._
+
+Push the gem to rubygems.org:
+
+```
+$ gem push nexmo_api_specification-1.1.0.gem
+```
+
+Verify the change was made by checking for the [new version on rubygems.org](https://rubygems.org/gems/nexmo_api_specification)

data/definitions/sms.yml

@@ -2,7 +2,7 @@ openapi: "3.0.0"
 info:
   version: 1.0.0
   title: SMS API
-  description: With the Nexmo SMS API you can send SMS from your account and lookup messages both messages that you've sent as well as messages sent to your virtual numbers.
+  description: With the Nexmo SMS API you can send SMS from your account and lookup messages both messages that you've sent as well as messages sent to your virtual numbers. Numbers are specified in E.164 format.
 servers:
   - url: https://rest.nexmo.com
 paths:
@@ -113,11 +113,11 @@ components:
         - to
       properties:
         from:
-          description: The name or number the message should be sent from. Alphanumeric senderID's are not supported in all countries, see [Global Messaging](/messaging/sms/guides/global-messaging#country-specific-features) for more details.
+          description: The name or number the message should be sent from. Alphanumeric senderID's are not supported in all countries, see [Global Messaging](/messaging/sms/guides/global-messaging#country-specific-features) for more details. If alphanumeric, spaces will be ignored. Numbers are specified in E.164 format.
           type: string
-          example: 'Acme Inc'
+          example: 'AcmeInc'
         to:
-          description: The number that the message should be sent to
+          description: The number that the message should be sent to. Numbers are specified in E.164 format. 
           type: string
           minLength: 7
           maxLength: 15
@@ -237,12 +237,12 @@ components:
       properties:
         msisdn:
           type: string
-          description: The phone number that this inbound message was sent from.
+          description: The phone number that this inbound message was sent from. Numbers are specified in E.164 format.
           example: '447700900001'
           required: true
         to:
           type: string
-          description: The phone number the message was sent to. **This is your virtual number**.
+          description: The phone number the message was sent to. **This is your virtual number**. Numbers are specified in E.164 format.
           example: '447700900000'
           required: true
         messageId:
@@ -311,7 +311,7 @@ components:
       properties:
         to:
           type: string
-          description: The number the message was sent to
+          description: The number the message was sent to. Numbers are specified in E.164 format.
           example: '447700900000'
         message-id:
           type: string
@@ -359,12 +359,12 @@ components:
       properties:
         msisdn:
           type: string
-          description: The number the message was sent to
+          description: The number the message was sent to. Numbers are specified in E.164 format.
           example: '447700900000'
         to:
           type: string
-          description: The SenderID you set in from in your request
-          example: Acme Inc
+          description: The SenderID you set in `from` in your request.
+          example: AcmeInc
         network-code:
           type: string
           description: The Mobile Country Code Mobile Network Code (MCCMNC) of the carrier this phone number is registered with.
@@ -462,7 +462,7 @@ x-errors:
 
   12:
     description: Desintation unreachable. The message could not be delivered to the phone number.
-    resolution: Check that your `to` number is valid. Make sure to use the country prefix (e.g. `44` for the UK) and not a `0`
+    resolution: Check that your `to` number is valid. Make sure to use the country prefix (e.g. `44` for the UK) and not a `0`. Numbers are specified in E.164 format.
 
   13:
     description: The carrier blocked this message because the content is not suitable for `to` based on age restrictions.)

data/lib/nexmo_api_specification/version.rb

@@ -1,3 +1,3 @@
 module NexmoApiSpecification
-  VERSION = '0.11.5'.freeze
+  VERSION = '0.11.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_api_specification
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.6
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler